How to get operation codes and service-menus

This document is designed to help you understand how you can fetch a list of all the operation codes and service-menus owned by a dealership and use filters. To get this data, you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us.

The endpoint mentioned below can be used to get the list of all the operation codes and service-menus owned by a dealership.

Request

HTTP request

POST https://api.mykaarma.com/opcodes/v1/dealers/{{dealerUUID}}/operations/searches

Parameters

Parameter Name	Value	Description
`dealerUUID`	`string`	Unique identifier (UUID) of the dealership for which you want to fetch the operation codes

Authorization

This request requires following scopes

Scope	Level	Description
`kopcode.operation.read`	`Dealer`	Authorizes client to get operation codes for given dealership

Pagination

Dealerships may contain a large number of opcodes, sometimes exceeding thousands. To ensure efficient data retrieval and prevent request timeouts, we strongly recommend using pagination when fetching opcodes. If pagination is not used, requests may time out, and excessive load may be placed on our APIs.

How to Use Pagination

To implement pagination, use the following two fields in your request body:

resultSize: Specifies the number of results per request. The maximum allowed value is 50.
startPosition: Identifies the starting index for pagination.

Example Workflow

Make an initial API request with resultSize set between 1 and 50 and startPosition set to 0.
The API will return up to X (value of resultSize) opcodes for Page 1.
In the response, you will receive a totalCount field, which indicates the total number of opcodes available for that dealer.
Use totalCount to calculate the total number of pages required.
For each subsequent page, increment the startPosition by resultSize while keeping resultSize constant.

Example Request

{
  "resultSize": 50,
  "startPosition": 0
}

Example Response

{
  "opcodes": [
    { "id": 1, "name": "Opcode 1" },
    { "id": 2, "name": "Opcode 2" }
    // ... up to resultSize entries
  ],
  "totalCount": 250
}

Pagination Logic

If totalCount is 250 and resultSize is 50, then:

Page 1: startPosition = 0
Page 2: startPosition = 50
Page 3: startPosition = 100
… and so on until all data is retrieved.

Following this approach ensures optimal performance and prevents request failures due to excessive data fetching. In the future, if we receive any request without pagination, we will automatically set resultSize to 50 and startPosition to 0 at our end, process that request, and return data accordingly.

Opcode Retrieval Based on BrandUUIDList

Overview of Brands mapping in Opcodes

An Opcode can be mapped to one or more brands. Opcodes may have the following brand-mapping behaviors:

Mapped to Specific Brands: An opcode is mapped with one or more brands.
Mapped to All Brands: An opcode applies to all brands.
Not Mapped to Any Brand: An opcode not mapped to any brand.

How Brands Are Mapped to Opcodes

Managers at dealership can update/map opcodes to brands via myKaarma Application

Behavior of `brandUUidList` in Request Body while fetching Opcodes

The brandUuidList filter is mainly relevant for dealerships having multiple brands. If a dealership has only one brand, filtering by brand UUID is unnecessary.

1. If brandUuidList is empty or not provided:

Returns all opcodes, including
- Opcodes mapped to specific brands.
- Opcodes mapped to all brands (ALL).
- Opcodes without any brand mappings.

Example Request

{
  "brandUuidList": []
}

Example Response

{
  "operationDTOList": [
    {
      "laborOpCode": "OPC123",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 1,
            "name": "Brand A",
            "motorsMakeId": 10,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-123",
          "uuid": "uuid-123",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC789",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 2,
            "name": "ALL",
            "motorsMakeId": 20,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-999",
          "uuid": "uuid-999",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC999",
      "vehicleMileageConfigDTOList": []
    }
  ]
}

2. If brandUuidList contains one or more brand UUIDs:

Returns opcodes that:
- Are mapped to the provided brand UUID(s).
- Are mapped to all brands (ALL).
- Have no mapped brands.
- Are mapped to multiple brands and include at least one matching the provided brand UUIDs.

Example Request

{
  "brandUuidList": ["brand-A-uuid", "brand-B-uuid"]
}

Example Response

{
  "operationDTOList": [
    {
      "laborOpCode": "OPC002",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 1,
            "name": "Brand A",
            "motorsMakeId": 10,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440001",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440001",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC003",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 40,
            "name": "Brand B",
            "motorsMakeId": 40,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440002",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440002",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC001",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 2,
            "name": "ALL",
            "motorsMakeId": 20,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-all",
          "uuid": "uuid-all",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC004",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 1,
            "name": "Brand A",
            "motorsMakeId": 10,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440001",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440003",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        },
        {
          "brandDTO": {
            "id": 3,
            "name": "Brand C",
            "motorsMakeId": 30,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440003",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440003",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC005",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 40,
            "name": "Brand B",
            "motorsMakeId": 40,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440002",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440004",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        },
        {
          "brandDTO": {
            "id": 4,
            "name": "Brand D",
            "motorsMakeId": 40,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "mileage-uuid-550e8400-e29b-41d4-a716-446655440004",
          "uuid": "uuid-550e8400-e29b-41d4-a716-446655440004",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ]
    },
    {
      "laborOpCode": "OPC006",
      "vehicleMileageConfigDTOList": []
    },
  ]
}

Request Body

Parameter Name	Value	Required	Description
`requesterUserUUID`	`string`	No	The unique identifier (UUID) of the user making the request. This field is used to identify the requester within the system.
`onlineSchedulerVisibility`	`boolean`	No	A flag indicating whether to only fetch the operation codes visible in the online scheduler. If `true`, only the operation codes which are visible in the online scheduler will be returned.
`mobileServiceVisibility`	`boolean`	No	A flag indicating whether to only fetch the operation codes visible in the mobile service. If `true`, only the operation codes which are visible in the mobile service will be returned.
`serviceCartVisibility`	`boolean`	No	A flag indicating whether to only fetch the operation codes visible in the service cart. If `true`, only the operation codes which are visible in the service cart will be returned.
`dealerAppSchedulerVisibility`	`boolean`	No	A flag indicating whether to only fetch the operation codes visible in the dealer app scheduler. If `true`, only the operation codes which are visible in the dealer app scheduler will be returned.
`checkInVisibility`	`boolean`	No	A flag indicating whether to only fetch the operation codes visible in the check-in. If `true`, only the operation codes which are visible in the check-in will be returned.
`startPosition`	`number`	No	The starting position for paginated results. This field is used to define the beginning index for fetching records.
`endPosition`	`number`	No	The ending position for paginated results. This field is used to define the last index for fetching records.
`isLastPage`	`boolean`	No	A flag indicating if the current set of results is the last page. If `true`, no further pages are available.
`resultSize`	`number`	No	The number of results returned in the current response. This field indicates the size of the result set.
`communicationCodes`	`list<string>`	No	A list of communication codes used for filtering the operation codes. Each string in the array represents a specific communication code.
`opCodes`	`list<string>`	No	A list of operation codes (`laborOpCode`) that are included in the request. Each string in the array represents a specific operation code.
`uuidList`	`list<string>`	No	A list of unique identifiers (UUIDs) of the operation codes. Each string in the array corresponds to a specific operation code.
`getTotalCount`	`boolean`	No	A flag indicating whether the total count of records should be included in the response. If `true`, the total number of records will be returned.
`getMkAndDmsSimilarOpcodeCount`	`boolean`	No	A flag that determines whether the count of similar operation codes between Mk and DMS should be returned. When set to `true`, this count will be included in the response.
`searchToken`	`string`	No	A token used for searching specific records or data. The search token helps in filtering the results based on the given criteria. Search can be done on `laborOpCode`, `mkDescription`, `dmsDescription`, `opCodeName` and `menuName`.
`sortPreference`	`string`	No	Defines the preferred field for sorting the results. Possible values `OPCODE`, `NAME`, `PRICE`.
`sortDirection`	`string`	No	Specifies the direction of sorting. Possible values are `ASCENDING` or `DESCENDING`.
`eventDealerAssociateUuid`	`string`	No	The unique identifier (UUID) of the dealer associate associated with the EVENT.
`serviceTypeList`	`list<string>`	No	A list of service types to filter the request. Each string in the array represents a specific type of service, possible values are `MAINTENANCE`, `REPAIR`, `INSPECT`, `SERVICE`.
`brandUuidList`	`list<string>`	No	A list of unique indentifiers (UUIDs) of the dealer supported brands. Each string in the array represents a specific brand's UUID.
`typeList`	`list<string>`	No	A list of types related to the request. Each string in the array represents a specific type, such as `OPCODE`.
`mileageDTOList`	`list<MileageDTO>`	No	A list of mileage data transfer objects (DTOs) that includes `startMileage`, `repeatInterval`, and `endMileage`. Each object defines the mileage parameters for filtering the operation codes.
`baseVehicleId`	`number`	No	The identifier for the base vehicle. This ID is used to specify the base model or type of vehicle associated with the operation codes.
`engineId`	`number`	No	The identifier for the engine. This field is used to specify the engine type associated with the operation codes.
`minPrice`	`number`	No	The minimum price filter for the results. This value sets the lower bound for total price in the operation codes.
`maxPrice`	`number`	No	The maximum price filter for the results. This value sets the upper bound for total price in the operation codes.
`dmsLaborPriceMismatch`	`boolean`	No	A flag indicating whether there is a mismatch in labor prices between the DMS (Dealer Management System) and myKaarma. If `true`, only the mismatched ones are returned.
`severityFlag`	`string`	No	A flag or indicator of the severity level associated with the operation codes. The value could represent different levels of severity (`NORMAL`, `SEVERE`).
`engineList`	`list<string>`	No	A list of engine types or models associated with the operation codes. Each string in the array represents a specific engine.
`modelList`	`list<string>`	No	A list of vehicle models associated with the operation codes. Each string in the array represents a specific model.
`yearList`	`list<string>`	No	A list of vehicle years associated with the operation codes. Each number in the array represents a specific model year.
`trimList`	`list<string>`	No	A list of vehicle trims associated with the request. Each string in the array represents a specific trim level.

Curl

curl -X POST "https://api.mykaarma.com/opcodes/v1/dealers/{{dealerUuid}}/operations/searches"
--header 'accept: application/json' \
-u "{{username}}:{{password}}" \
--header 'Content-Type: application/json' \
--data-raw '{
  "requesterUserUUID": {{requesterUserUUID}},
  "onlineSchedulerVisibility": {{onlineSchedulerVisibility}},
  "mobileServiceVisibility": {{mobileServiceVisibility}},
  "serviceCartVisibility": {{serviceCartVisibility}},
  "dealerAppSchedulerVisibility": {{dealerAppSchedulerVisibility}},
  "checkInVisibility": {{checkInVisibility}},
  "startPosition": {{startPosition}},
  "endPosition": {{endPosition}},
  "isLastPage": {{isLastPage}},
  "resultSize": {{resultSize}},
  "communicationCodes": {{communicationCodes}},
  "opCodes": {{opCodes}},
  "uuidList": {{uuidList}},
  "getTotalCount": {{getTotalCount}},
  "getMkAndDmsSimilarOpcodeCount": {{getMkAndDmsSimilarOpcodeCount}},
  "searchToken": {{searchToken}},
  "sortPreference": {{sortPreference}},
  "sortDirection": {{sortDirection}},
  "eventDealerAssociateUuid": {{eventDealerAssociateUuid}},
  "serviceTypeList": {{serviceTypeList}},
  "brandUuidList": {{brandUUidList}},
  "typeList": {{typeList}},
  "mileageDTOList": [
    {
      "startMileage": {{startMileage}},
      "repeatInterval": {{repeatInterval}},
      "endMileage": {{endMileage}}
    }
  ],
  "baseVehicleId": {{baseVehicleId}},
  "engineId": {{engineId}},
  "minPrice": {{minPrice}},
  "maxPrice": {{maxPrice}},
  "dmsLaborPriceMismatch": {{dmsLaborPriceMismatch}},
  "severityFlag": {{severityFlag}},
  "engineList": {{engineList}},
  "modelList": {{modelList}},
  "yearList": {{yearList}},
  "trimList": {{trimList}}
}'

Response

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string",
  "operationDTOList": [
    {
      "laborOpCode": "string",
      "opCodeName": "string",
      "description": "string",
      "totalPrice": "string",
      "opCodeDurationInMinutes": "string",
      "isValid": true,
      "uuid": "string",
      "inMobileService": true,
      "inOnlineScheduler": true,
      "communicationCode": "string",
      "payType": "string",
      "inServiceCart": true,
      "inDealerAppScheduler": true,
      "dmsDescription": "string",
      "laborPrice": "string",
      "dmsLaborPrice": "string",
      "partsPrice": "string",
      "dmsPartsPrice": "string",
      "taxAmount": "string",
      "dmsTaxAmount": "string",
      "dmsTotalPrice": "string",
      "sortOrder": 0,
      "correction": "string",
      "cause": "string",
      "soldHours": 0,
      "dispatchCode": "string",
      "comebackFlag": true,
      "usagePercentile": 0,
      "position": 0,
      "leadTimeInMinutes": 0,
      "isIndexed": true,
      "isDefault": true,
      "notes": "string",
      "serviceType": "string",
      "serviceTypeServiceCart": "string",
      "recallId": "string",
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 0,
            "name": "string",
            "motorsMakeId": 0,
            "motorsMakeName": "string"
          },
          "year": "string",
          "model": "string",
          "trim": "string",
          "engine": "string",
          "mileageUuid": "string",
          "uuid": "string",
          "motorsBaseVehicleId": "string",
          "motorsEngineId": "string",
          "isValid": true
        }
      ],
      "dailyLimitConfigDTOList": [
        {
          "dayNumber": 0,
          "dayLimit": 0
        }
      ],
      "pullEstimateInSC": true,
      "miscPrice": "string",
      "useDmsPrice": true,
      "showDmsPriceMismatchWarning": true,
      "noPartsNeeded": true,
      "inCheckIn": true,
      "quickOpLiteUuid": "string",
      "invoiceLineList": [
        "string"
      ],
      "menuName": "string",
      "operationType": "OPCODE",
      "dealerUuid": "string",
      "isCustomConcern": true,
      "taxonomyId": 0,
      "severityFlag": "string",
      "isSeverityNormal": true,
      "isSeveritySevere": true,
      "notesSevere": [
        "string"
      ],
      "notesNormal": [
        "string"
      ],
      "motorsOperationName": "string",
      "mileage": 0,
      "motorsMake": "string",
      "motorsMakeId": 0,
      "totalPriceForConversion": 0
    }
  ],
  "totalCount": 0,
  "mkAndDmsSimilarOpcodeCount": 0,
  "pricingVisibleToCustomer": true
}

Sample Response

{
  "errors": null,
  "warnings": null,
  "statusCode": 200,
  "apiRequestId": "a9af1d5e-7909-4c5b-8051-a46c52369acd",
  "operationDTOList": [
    {
      "laborOpCode": "00MYKOIL",
      "opCodeName": "Mykaarma Service",
      "description": "First complimentary oil and filter change.",
      "totalPrice": "848.54",
      "opCodeDurationInMinutes": "3",
      "isValid": true,
      "uuid": "BMKaaGcUuILk_-X-WLOpuqSBLpiOdIRkJ7yPHeDk3r8",
      "inMobileService": false,
      "inOnlineScheduler": true,
      "communicationCode": null,
      "payType": null,
      "inServiceCart": true,
      "inDealerAppScheduler": true,
      "dmsDescription": null,
      "laborPrice": null,
      "dmsLaborPrice": null,
      "partsPrice": "848.54",
      "dmsPartsPrice": null,
      "taxAmount": null,
      "dmsTaxAmount": null,
      "dmsTotalPrice": null,
      "sortOrder": 1,
      "correction": null,
      "cause": null,
      "soldHours": 0,
      "dispatchCode": null,
      "comebackFlag": null,
      "usagePercentile": null,
      "position": 0,
      "leadTimeInMinutes": null,
      "isIndexed": true,
      "isDefault": false,
      "notes": "First Complimentary in-house Service",
      "serviceType": "maintenance",
      "serviceTypeServiceCart": null,
      "recallId": null,
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": -1,
            "name": "ALL",
            "motorsMakeId": 0,
            "motorsMakeName": null
          },
          "year": "ALL",
          "model": "ALL",
          "trim": "ALL",
          "engine": "ALL",
          "mileageUuid": "oycKFuETr-rbZhW3jJdNSps3ILa_hnICIdjbaAh65-I",
          "uuid": "5zbqGG8p23DNDA_IWBS-szskfnQZnLEE8RIDXo1uM1s",
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ],
      "dailyLimitConfigDTOList": [
        {
          "dayNumber": 0,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 1,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 2,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 3,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 4,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 5,
          "dayLimit": 2147483647
        },
        {
          "dayNumber": 6,
          "dayLimit": 2147483647
        }
      ],
      "pullEstimateInSC": null,
      "miscPrice": null,
      "useDmsPrice": null,
      "showDmsPriceMismatchWarning": null,
      "noPartsNeeded": false,
      "inCheckIn": true,
      "quickOpLiteUuid": null,
      "invoiceLineList": null,
      "menuName": null,
      "operationType": "OPCODE",
      "dealerUuid": "29855ff5a66481efac200a67bf806c38f28e378b84e3dd46ec8578ca00ba31dd",
      "isCustomConcern": null,
      "taxonomyId": 0,
      "severityFlag": null,
      "isSeverityNormal": null,
      "isSeveritySevere": null,
      "notesSevere": null,
      "notesNormal": null,
      "motorsOperationName": null,
      "mileage": null,
      "motorsMake": null,
      "motorsMakeId": 0,
      "totalPriceForConversion": 848.54
    },
    {
      "laborOpCode": "00MYKOIL",
      "opCodeName": null,
      "description": "Oil leak and filter change",
      "totalPrice": "37.0",
      "opCodeDurationInMinutes": null,
      "isValid": true,
      "uuid": "ZNCB8aQ1GPVwPpZIE_BO-aBjtGJt2ocK-dwYUFaoPFI",
      "inMobileService": false,
      "inOnlineScheduler": true,
      "communicationCode": null,
      "payType": null,
      "inServiceCart": true,
      "inDealerAppScheduler": false,
      "dmsDescription": null,
      "laborPrice": "10.0",
      "dmsLaborPrice": null,
      "partsPrice": "15.0",
      "dmsPartsPrice": null,
      "taxAmount": null,
      "dmsTaxAmount": null,
      "dmsTotalPrice": null,
      "sortOrder": null,
      "correction": null,
      "cause": null,
      "soldHours": null,
      "dispatchCode": null,
      "comebackFlag": null,
      "usagePercentile": null,
      "position": 0,
      "leadTimeInMinutes": null,
      "isIndexed": true,
      "isDefault": null,
      "notes": "Test Menu for Oil and filter Change",
      "serviceType": "MAINTENANCE",
      "serviceTypeServiceCart": "Mechanical Repair",
      "recallId": null,
      "vehicleMileageConfigDTOList": [
        {
          "brandDTO": {
            "id": 85,
            "name": "Mykaarma Auto",
            "motorsMakeId": 0,
            "motorsMakeName": null
          },
          "year": "2022",
          "model": "Grand",
          "trim": "LXI",
          "engine": "2.0L L4 (N) EC2 Turbocharged GAS FI",
          "mileageUuid": "cxlAICikyoWE4mF7ddut0hp6abeIzJn4vkFg6QdxCK4",
          "uuid": null,
          "motorsBaseVehicleId": null,
          "motorsEngineId": null,
          "isValid": null
        }
      ],
      "dailyLimitConfigDTOList": null,
      "pullEstimateInSC": null,
      "miscPrice": "12",
      "useDmsPrice": null,
      "showDmsPriceMismatchWarning": null,
      "noPartsNeeded": null,
      "inCheckIn": false,
      "quickOpLiteUuid": "4NcTfjv3Xf4dZoBMe2fUp-9ffQfjHtrX2Eg89X-Q53c",
      "invoiceLineList": [
        {
          "laborOpCode": "01MYKOIL",
          "opCodeName": "Oil Leak",
          "description": "Oil Leak",
          "totalPrice": "0.0",
          "opCodeDurationInMinutes": null,
          "isValid": false,
          "uuid": "4NcTfjv3Xf4dZoBMe2fUp-9ffQfjHtrX2Eg89X-Q53c",
          "inMobileService": false,
          "inOnlineScheduler": false,
          "communicationCode": null,
          "payType": null,
          "inServiceCart": false,
          "inDealerAppScheduler": false,
          "dmsDescription": null,
          "laborPrice": null,
          "dmsLaborPrice": null,
          "partsPrice": null,
          "dmsPartsPrice": null,
          "taxAmount": null,
          "dmsTaxAmount": null,
          "dmsTotalPrice": null,
          "sortOrder": 1,
          "correction": null,
          "cause": null,
          "soldHours": 0,
          "dispatchCode": null,
          "comebackFlag": null,
          "usagePercentile": null,
          "position": 0,
          "leadTimeInMinutes": null,
          "isIndexed": true,
          "isDefault": false,
          "notes": "For Advisor Use Only",
          "serviceType": "repair",
          "serviceTypeServiceCart": null,
          "recallId": null,
          "vehicleMileageConfigDTOList": null,
          "dailyLimitConfigDTOList": null,
          "pullEstimateInSC": null,
          "miscPrice": null,
          "useDmsPrice": null,
          "showDmsPriceMismatchWarning": null,
          "noPartsNeeded": false,
          "inCheckIn": false,
          "quickOpLiteUuid": null,
          "invoiceLineList": null,
          "menuName": null,
          "operationType": "OPCODE",
          "dealerUuid": "29855ff5a66481efac200a67bf806c38f28e378b84e3dd46ec8578ca00ba31dd",
          "isCustomConcern": null,
          "taxonomyId": 0,
          "severityFlag": null,
          "isSeverityNormal": null,
          "isSeveritySevere": null,
          "notesSevere": null,
          "notesNormal": null,
          "motorsOperationName": null,
          "mileage": null,
          "motorsMake": null,
          "motorsMakeId": 0,
          "totalPriceForConversion": 0
        },
        {
          "laborOpCode": "02MYKOIL",
          "opCodeName": "Oil Services",
          "description": "Oil Services change",
          "totalPrice": "0.0",
          "opCodeDurationInMinutes": null,
          "isValid": false,
          "uuid": "GcexZomkzmVC63H4PSEF737kQA40zzFE3AZr9RVMvHc",
          "inMobileService": false,
          "inOnlineScheduler": true,
          "communicationCode": null,
          "payType": null,
          "inServiceCart": true,
          "inDealerAppScheduler": true,
          "dmsDescription": null,
          "laborPrice": null,
          "dmsLaborPrice": null,
          "partsPrice": null,
          "dmsPartsPrice": null,
          "taxAmount": null,
          "dmsTaxAmount": null,
          "dmsTotalPrice": null,
          "sortOrder": 2,
          "correction": null,
          "cause": null,
          "soldHours": null,
          "dispatchCode": null,
          "comebackFlag": null,
          "usagePercentile": null,
          "position": 0,
          "leadTimeInMinutes": null,
          "isIndexed": true,
          "isDefault": false,
          "notes": "For Advisor Use Only",
          "serviceType": "maintenance",
          "serviceTypeServiceCart": null,
          "recallId": null,
          "vehicleMileageConfigDTOList": null,
          "dailyLimitConfigDTOList": null,
          "pullEstimateInSC": null,
          "miscPrice": null,
          "useDmsPrice": null,
          "showDmsPriceMismatchWarning": null,
          "noPartsNeeded": false,
          "inCheckIn": true,
          "quickOpLiteUuid": null,
          "invoiceLineList": null,
          "menuName": null,
          "operationType": "OPCODE",
          "dealerUuid": "29855ff5a66481efac200a67bf806c38f28e378b84e3dd46ec8578ca00ba31dd",
          "isCustomConcern": null,
          "taxonomyId": 0,
          "severityFlag": null,
          "isSeverityNormal": null,
          "isSeveritySevere": null,
          "notesSevere": null,
          "notesNormal": null,
          "motorsOperationName": null,
          "mileage": null,
          "motorsMake": null,
          "motorsMakeId": 0,
          "totalPriceForConversion": 0
        },
        {
          "laborOpCode": "03MYKFILTER",
          "opCodeName": "Filter Change",
          "description": "Oil & Filter Change. Includes Multi-Point Inspection",
          "totalPrice": "0.0",
          "opCodeDurationInMinutes": null,
          "isValid": false,
          "uuid": "tbwR9E0vRd6askUrh-aQbXCRdDmJd6FAAXIYZQfd4ao",
          "inMobileService": false,
          "inOnlineScheduler": false,
          "communicationCode": null,
          "payType": null,
          "inServiceCart": true,
          "inDealerAppScheduler": false,
          "dmsDescription": null,
          "laborPrice": null,
          "dmsLaborPrice": null,
          "partsPrice": null,
          "dmsPartsPrice": null,
          "taxAmount": null,
          "dmsTaxAmount": null,
          "dmsTotalPrice": null,
          "sortOrder": 3,
          "correction": null,
          "cause": null,
          "soldHours": null,
          "dispatchCode": null,
          "comebackFlag": null,
          "usagePercentile": null,
          "position": 0,
          "leadTimeInMinutes": null,
          "isIndexed": true,
          "isDefault": false,
          "notes": "Filter change pricing starts at $80.50.",
          "serviceType": "maintenance",
          "serviceTypeServiceCart": null,
          "recallId": null,
          "vehicleMileageConfigDTOList": null,
          "dailyLimitConfigDTOList": null,
          "pullEstimateInSC": null,
          "miscPrice": null,
          "useDmsPrice": null,
          "showDmsPriceMismatchWarning": null,
          "noPartsNeeded": false,
          "inCheckIn": true,
          "quickOpLiteUuid": null,
          "invoiceLineList": null,
          "menuName": null,
          "operationType": "OPCODE",
          "dealerUuid": "29855ff5a66481efac200a67bf806c38f28e378b84e3dd46ec8578ca00ba31dd",
          "isCustomConcern": null,
          "taxonomyId": 0,
          "severityFlag": null,
          "isSeverityNormal": null,
          "isSeveritySevere": null,
          "notesSevere": null,
          "notesNormal": null,
          "motorsOperationName": null,
          "mileage": null,
          "motorsMake": null,
          "motorsMakeId": 0,
          "totalPriceForConversion": 0
        }
      ],
      "menuName": "OIL CHANGE MENU",
      "operationType": "SERVICEMENU",
      "dealerUuid": "29855ff5a66481efac200a67bf806c38f28e378b84e3dd46ec8578ca00ba31dd",
      "isCustomConcern": null,
      "taxonomyId": 0,
      "severityFlag": null,
      "isSeverityNormal": null,
      "isSeveritySevere": null,
      "notesSevere": null,
      "notesNormal": null,
      "motorsOperationName": null,
      "mileage": null,
      "motorsMake": null,
      "motorsMakeId": 0,
      "totalPriceForConversion": 37
    }
  ],
  "totalCount": 211,
  "mkAndDmsSimilarOpcodeCount": null,
  "pricingVisibleToCustomer": true
}

Operation data model

Please refer to operation data model to see all the parameters you will get when you get opcodes and factory menus from myKaarma APIs or events.

Request​

HTTP request​

Parameters​

Authorization​

Pagination​

How to Use Pagination​

Example Workflow​

Example Request​

Example Response​

Pagination Logic​

Opcode Retrieval Based on BrandUUIDList​

Overview of Brands mapping in Opcodes​

How Brands Are Mapped to Opcodes​

Behavior of brandUUidList in Request Body while fetching Opcodes​

Example Request​

Example Response​

Example Request​

Example Response​

Request Body​

Curl​

Response​

Sample Response​

Operation data model​

Request

HTTP request

Parameters

Authorization

Pagination

How to Use Pagination

Example Workflow

Example Request

Example Response

Pagination Logic

Opcode Retrieval Based on BrandUUIDList

Overview of Brands mapping in Opcodes

How Brands Are Mapped to Opcodes

Behavior of `brandUUidList` in Request Body while fetching Opcodes

Example Request

Example Response

Example Request

Example Response

Request Body

Curl

Response

Sample Response

Operation data model