SAsamsara
Maintenance

Update a warranty claim

Updates an existing warranty claim for the organization.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Warranties under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

patch/maintenance/warranty-claims

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

idstring required

Unique identifier for the WarrantyClaim record.

Request body

assetIdstring

ID of the asset the claim is filed for. Immutable once set.

causestring

The cause of the 3 Cs - the root cause found.

claimEngineHoursinteger

Engine hours at the time of repair.

claimOdometerMetersinteger

Asset odometer reading at the time of repair. Measured in meters.

claimStatus'unknown' | 'created' | 'submitted' | 'inReview' | 'approved' | 'rejected' | 'resubmitted' | 'reimbursed'

Current status of the claim. Valid values: unknown, created, submitted, inReview, approved, rejected, resubmitted, reimbursed

componentInstanceIdsstring[]

IDs of asset component instances covered by this claim.

concernstring

The concern of the 3 Cs - what was reported.

correctionstring

The correction of the 3 Cs - the work performed.

linkedWarrantyIdstring

ID of the warranty this claim is filed against.

linkedWorkOrderIdsstring[]

IDs of the work orders associated with this claim.

mediaItemIdsstring[]

IDs of media items attached to the claim.

reimbursedAtTimestring

When reimbursement was received.

repairCompletedAtTimestring

When the repair was completed.

resolutionAtTimestring

When the claim was resolved.

submittedAtTimestring

When the claim was submitted to the vendor.

warrantyVendorIdstring

ID of the vendor handling the claim.

Example request

{
  "assetId": "281474976710656",
  "cause": "12345",
  "claimEngineHours": 12345,
  "claimOdometerMeters": 12345,
  "claimStatus": "unknown",
  "componentInstanceIds": [
    "12345",
    "12345",
    "12345"
  ],
  "concern": "12345",
  "correction": "12345",
  "externalIds": [
    {
      "key": "12345",
      "value": "12345"
    }
  ],
  "labor": [
    {
      "cost": {
        "amount": "12345",
        "currency": "12345"
      },
      "description": "12345",
      "serviceTaskId": "12345",
      "sourceWorkOrderId": "12345",
      "vmrsCode": "12345"
    }
  ],
  "linkedWarrantyId": "281474976710656",
  "linkedWorkOrderIds": [
    "12345",
    "12345"
  ],
  "mediaItemIds": [
    "12345",
    "12345",
    "12345"
  ],
  "otherCost": {
    "amount": "12345",
    "currency": "12345"
  },
  "parts": [
    {
      "cost": {
        "amount": "12345",
        "currency": "12345"
      },
      "description": "12345",
      "partDefinitionId": "12345",
      "partId": "12345",
      "quantity": 12345,
      "serviceTaskId": "12345",
      "sourceWorkOrderId": "12345",
      "vmrsCode": "12345"
    }
  ],
  "reimbursedAtTime": "2019-06-13T19:08:25Z",
  "reimbursements": [
    {
      "reimbursement": {
        "amount": "12345",
        "currency": "12345"
      },
      "workOrderId": "12345"
    }
  ],
  "repairCompletedAtTime": "2019-06-13T19:08:25Z",
  "resolutionAtTime": "2019-06-13T19:08:25Z",
  "submittedAtTime": "2019-06-13T19:08:25Z",
  "warrantyVendorId": "281474976710656"
}

Response

OK response.

Example response

{
  "data": {
    "asset": {
      "id": "281474976710656"
    },
    "cause": "12345",
    "claimEngineHours": 12345,
    "claimOdometerMeters": 12345,
    "claimStatus": "unknown",
    "componentInstanceIds": [
      "12345",
      "12345"
    ],
    "concern": "12345",
    "correction": "12345",
    "createdAtTime": "2019-06-13T19:08:25Z",
    "externalIds": [
      {
        "key": "12345",
        "value": "12345"
      }
    ],
    "id": "12345",
    "labor": [
      {
        "cost": {
          "amount": "12345",
          "currency": "12345"
        },
        "description": "12345",
        "serviceTaskId": "12345",
        "sourceWorkOrderId": "12345",
        "vmrsCode": "12345"
      }
    ],
    "linkedWarranty": {
      "id": "281474976710656"
    },
    "linkedWorkOrderIds": [
      "12345",
      "12345"
    ],
    "mediaItemIds": [
      "12345",
      "12345"
    ],
    "otherCost": {
      "amount": "12345",
      "currency": "12345"
    },
    "parts": [
      {
        "cost": {
          "amount": "12345",
          "currency": "12345"
        },
        "description": "12345",
        "partDefinitionId": "12345",
        "partId": "12345",
        "quantity": 12345,
        "serviceTaskId": "12345",
        "sourceWorkOrderId": "12345",
        "vmrsCode": "12345"
      }
    ],
    "reimbursedAtTime": "2019-06-13T19:08:25Z",
    "reimbursements": [
      {
        "reimbursement": {
          "amount": "12345",
          "currency": "12345"
        },
        "workOrderId": "12345"
      }
    ],
    "repairCompletedAtTime": "2019-06-13T19:08:25Z",
    "resolutionAtTime": "2019-06-13T19:08:25Z",
    "statusHistory": [
      {
        "happenedAtTime": "2019-06-13T19:08:25Z",
        "status": "unknown",
        "userId": "12345"
      }
    ],
    "submittedAtTime": "2019-06-13T19:08:25Z",
    "updatedAtTime": "2019-06-13T19:08:25Z",
    "warrantyVendor": {
      "id": "281474976710656"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.