Service History API

Service History
 1.8.0 
OAS3

Introduction

The Service History API is a resource that can be used to get service history data.

Common Parameters

All methods will have the following required parameters (passed as part of URL path):

  1. enterpriseId is the dealership group unique identifier.

  2. storeId is the unique identifier (within enterpriseId) for a single dealership physical store.

All methods will have the following optional parameters (passed as http headers):

  1. correlation-id is a unique identifier value (guid) that is attached to requests and messages that allow reference to a particular transaction or event chain.
  2. log-level sets the application log-level to wanted level. Useful if a particular message is causing trouble and needs tracing. Available values: trace, debug, info, warn, error, fatal

[0.0.2]

  • Change to Keyloop

[1.6.0]

  • Version number aligned with DMS client data conract version for ServiceHistory
  • Added Line Payer to Fee, Labors, Menu, Parts

[1.6.1]

  • Patched DMS client for ServiceHistory

[1.7.1]

  • Version alignment
  • Remove unused parameters correlation-id and log level

[1.8.0]

  • Adding fees to ServiceHistoryMenu
Servers
Computed URL:https://api-platform-ingress.eu-dev.keyloop.io/service-history/sample/sample/v1

Server variables

enterpriseIdstoreId
enterpriseId
storeId

Queries

Find and retrieve data without writing back changes to the resource.

GET​/service-history​/{serviceHistoryId}
Get Service History

Retrieve a service history for a given {serviceHistoryId}

Parameters

NameDescription
serviceHistoryId *
string
(path)

Service History Id

Responses

CodeDescriptionLinks
200

Success

Media type
Controls Accept header.
{
  "serviceHistoryId": "string",
  "serviceDate": "2025-08-07T06:24:59.789Z",
  "description": "string",
  "serviceMileage": {
    "unit": "KM",
    "value": 0
  },
  "vehicle": {
    "identification": {
      "vin": "string",
      "chassis": "string",
      "licensePlate": "string",
      "engineNumber": "string"
    },
    "description": {
      "class": "UNKNOWN",
      "make": "string",
      "model": "string",
      "variant": "string",
      "modelYear": 0,
      "vehicle": "string",
      "exteriorColor": "string",
      "interiorColor": "string"
    },
    "referenceData": {
      "providerId": "string",
      "makeCode": "string",
      "modelCode": "string",
      "variantCode": "string",
      "vehicleCode": "string",
      "serviceGroupCode": "string",
      "exteriorColorCode": "string",
      "interiorColorCode": "string"
    }
  },
  "workshop": {
    "name": "string"
  },
  "menus": [
    {
      "description": "string",
      "labors": [
        {
          "description": "string",
          "code": "string",
          "allowedTimeInMinutes": 0,
          "orderPrice": {
            "netValue": 0,
            "grossValue": 0,
            "taxValue": 0,
            "taxRate": 0,
            "currencyCode": "string"
          },
          "linePayer": "CUSTOMER",
          "discount": {
            "value": 0,
            "currencyCode": "string",
            "type": "PERCENTAGE"
          },
          "notes": "string"
        }
      ],
      "fees": [
        {
          "feeCode": "string",
          "description": "string",
          "notes": "string",
          "quantity": 0,
          "discount": {
            "value": 0,
            "currencyCode": "string",
            "type": "PERCENTAGE"
          },
          "orderPrice": {
            "netValue": 0,
            "grossValue": 0,
            "taxValue": 0,
            "taxRate": 0,
            "currencyCode": "string"
          },
          "linePayer": "CUSTOMER"
        }
      ],
      "parts": [
        {
          "description": "string",
          "code": "string",
          "quantity": 0,
          "orderPrice": {
            "netValue": 0,
            "grossValue": 0,
            "taxValue": 0,
            "taxRate": 0,
            "currencyCode": "string"
          },
          "linePayer": "CUSTOMER",
          "discount": {
            "value": 0,
            "currencyCode": "string",
            "type": "PERCENTAGE"
          },
          "notes": "string"
        }
      ],
      "texts": [
        {
          "description": "string"
        }
      ],
      "orderPrice": {
        "netValue": 0,
        "grossValue": 0,
        "taxValue": 0,
        "taxRate": 0,
        "currencyCode": "string"
      },
      "linePayer": "CUSTOMER",
      "discount": {
        "value": 0,
        "currencyCode": "string",
        "type": "PERCENTAGE"
      },
      "notes": "string"
    }
  ],
  "labors": [
    {
      "description": "string",
      "code": "string",
      "allowedTimeInMinutes": 0,
      "orderPrice": {
        "netValue": 0,
        "grossValue": 0,
        "taxValue": 0,
        "taxRate": 0,
        "currencyCode": "string"
      },
      "linePayer": "CUSTOMER",
      "discount": {
        "value": 0,
        "currencyCode": "string",
        "type": "PERCENTAGE"
      },
      "notes": "string"
    }
  ],
  "parts": [
    {
      "description": "string",
      "code": "string",
      "quantity": 0,
      "orderPrice": {
        "netValue": 0,
        "grossValue": 0,
        "taxValue": 0,
        "taxRate": 0,
        "currencyCode": "string"
      },
      "linePayer": "CUSTOMER",
      "discount": {
        "value": 0,
        "currencyCode": "string",
        "type": "PERCENTAGE"
      },
      "notes": "string"
    }
  ],
  "texts": [
    {
      "description": "string"
    }
  ],
  "fees": [
    {
      "feeCode": "string",
      "description": "string",
      "notes": "string",
      "quantity": 0,
      "discount": {
        "value": 0,
        "currencyCode": "string",
        "type": "PERCENTAGE"
      },
      "orderPrice": {
        "netValue": 0,
        "grossValue": 0,
        "taxValue": 0,
        "taxRate": 0,
        "currencyCode": "string"
      },
      "linePayer": "CUSTOMER"
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "string",
      "href": "string",
      "title": "string"
    }
  ]
}
No links
404

Not Found

Media type
{
  "name": "string",
  "correlationId": "string",
  "message": "string",
  "informationLink": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "string",
      "issue": "string"
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "string",
      "href": "string",
      "title": "string"
    }
  ]
}
No links
GET​/service-history
Service History search

Search for a Service History record using the filter criteria specified within the query parameters - at least one search parameter must be specified.

Parameters

NameDescription
vin
string
(query)

Vehicle VIN used for filtering the results

serviceDate
string
(query)

Date when the service was performed

page
integer
(query)
pageSize
integer
(query)

Responses

CodeDescriptionLinks
200

Success

Media type
Controls Accept header.
{
  "totalItems": 0,
  "totalPages": 0,
  "serviceHistoryEntries": [
    {
      "vehicle": {
        "identification": {
          "vin": "string",
          "chassis": "string",
          "licensePlate": "string",
          "engineNumber": "string"
        },
        "description": {
          "class": "UNKNOWN",
          "make": "string",
          "model": "string",
          "variant": "string",
          "modelYear": 0,
          "vehicle": "string",
          "exteriorColor": "string",
          "interiorColor": "string"
        },
        "referenceData": {
          "providerId": "string",
          "makeCode": "string",
          "modelCode": "string",
          "variantCode": "string",
          "vehicleCode": "string",
          "serviceGroupCode": "string",
          "exteriorColorCode": "string",
          "interiorColorCode": "string"
        }
      },
      "serviceHistory": [
        {
          "serviceHistoryId": "string",
          "serviceDate": "2025-08-07T06:24:59.799Z",
          "description": "string",
          "serviceMileage": {
            "unit": "KM",
            "value": 0
          },
          "workshop": {
            "name": "string"
          },
          "repairOrderId": "string",
          "invoiceNo": "string",
          "orderPrice": {
            "netValue": 0,
            "grossValue": 0,
            "taxValue": 0,
            "taxRate": 0,
            "currencyCode": "string"
          },
          "discount": {
            "value": 0,
            "currencyCode": "string",
            "type": "PERCENTAGE"
          }
        }
      ]
    }
  ],
  "links": [
    {
      "method": "GET",
      "rel": "string",
      "href": "string",
      "title": "string"
    }
  ]
}
No links

Schemas

V1.ServiceHistory.ServiceHistoryResponse200
V1.ServiceHistory.ServiceHistorySearchResponse200
V1.ServiceHistory.ServiceHistoryWorkshop
V1.ServiceHistory.ServiceHistoryLabor
V1.ServiceHistory.ServiceHistoryPart
V1.ServiceHistory.ServiceHistoryText
V1.ServiceHistory.ServiceHistoryMenu
V1.ServiceHistory.ServiceHistoryFee
V1.ServiceHistory.ServiceHistorySearchResults
V1.ServiceHistory.ServiceHistoryVehicle
V1.LinksMethodEnum
V1.ServiceHistory.LinePayerEnum
V1.Price
V1.DiscountTypeEnum
V1.Discount
Elements.Api.Services.Error.ErrorResponse
Elements.Api.Services.Error.ErrorDetails
V1.Vehicle.VehicleMileageMileageUnitEnum
V1.Vehicle.VehicleMileage
V1.ServiceHistory.ServiceHistorySearchEntry
V1.Vehicle.VehicleIdentification
V1.Vehicle.VehicleReferenceData
V1.Vehicle.VehicleDescription
V1.Vehicle.VehicleDescriptionClassEnum