Quickstart Guide

In order to be able to create, modify, upload and remove quotations and supplements, you will need to first accept the relevant quote request and assign a unique job reference to the request.

Let's start by getting a request from the API.

Getting a request

In order to get a request, you will need to issue a GET request to the following endpoint:

GET https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/requests
Authorization: "Bearer " + access_token
Content-Type: application/json

This endpoint will respond with an array of pending (non-accepted) requests.

[
  {
    "id": 1234,
    "expiry": ...,
    "claim_number": ...,
    "instructions": {
      ...
    }
  }
]

Now that we have a request, lets accept the request and create a job.

Accept a request

You can then accept the request by sending a POST request to the following endpoint, using the {id} parameter as the value of the id of the request we received above.

https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/requests/{id}

You will need to provide any required parameters along with this request:

Your unique reference should be unique. If you try and accept more than one quotation with the same unique reference, you will get an error. For now, use the following values for the request:

Don't forget to include your access_token with the request.

POST https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/requests/1234
Authorization: "Bearer " + access_token
Content-Type: application/json
 
referenceId=TEST

You will receive back a response with a location header confirming the acceptance of the request, which can then be used to interact with the job:

POST https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/requests/1234
201 CREATED
Location: https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/jobs/TEST
Content-Type: application/json

This response will contain the created job's details as a job object:

{
    "id": "TEST",
    ...
}

Now that you have accepted the request, you will be able to interact with the job. Let's upload a quote.

Creating a quote

You can create a quote by sending a POST request to the following endpoint:

https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/jobs/{id}/quotes

When sending a quote, you should include the Quote object in the body of the request. For a detailed breakdown of the Quote object, please click here.

POST https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/jobs/TEST/quotes
Authorization: "Bearer " + access_token
Content-Type: application/json

{
  "type": "Estimate",
  "status": "Draft",
  "referenceId": "TEST",
  "rates": [
    {
      "type": "RemoveReplace",
      "rate": 50
    },
    ...
  ],
  "items": [
    {
      "type": "RemoveReplace",
      "description": "FBDA",
      "quantity": 1
    },
    ...
  ],
  ...
}

You will receive back a response with the created Quote object.

{
  "type": "Estimate",
  "status": "Draft",
  "referenceId": "TEST",
  "rates": [
    {
      "type": "RemoveReplace",
      "rate": 50
    },
    ...
  ],
  "items": [
    {
      "id": 1,
      "type": "RemoveReplace",
      "description": "FBDA",
      "quantity": 1
    },
    ...
  ],
  ...
}

While the quote is in the Draft status, you will be able to modify the quote.

Submitting a quote

Once the quote is ready to be submitted for assessment, you can update the status by sending a PUT request to the following endpoint:

https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/jobs/{id}/quote/{quoteId}/status

Note, the quoteId parameter is the value submitted for the type property in the quote object. When sending the request, you should include the desired status in the request body. For now, use the following values:

POST https://staging.ap-southeast-2.aws.helloclaims.com/integrations/repairer/jobs/TEST/quotes/Estimate/status
200 Success
Authorization: "Bearer " + access_token
Content-Type: application/json
 
status=Submitted

You will receive back a response with the created quote object.

{
  "type": "Estimate",
  "status": "Submitted",
  ...
}