Skip to main content

How to read an order for Service Department

This document is designed to help you understand how you can read a Repair Order for the Service Department. The returned order will contain all the relevant order information. To use this endpoint, you first need your credentials. If you don't already have them, head over to the Authentication and Authorization page to see how you can request credentials from us.

Parameters Used

Path parameters

Parameter NameValueDescriptionRequired
departmentUUIDStringUnique identifier of dealer departmentYes
orderUUIDStringUnique identifier of dealer orderYes

Authorization

Parameter NameDescriptionRequired
{{basic_auth_token}}Authorization: Base64 encoded string using Service Subscriber Username and passwordYes

Scope

This request requires the following authorization scopes:

ScopeLevelDescription
order.fetchDealerDepartmentAuthorizes client to read service order for provided user's dealer department

Endpoint

curl -X GET "https://api.mykaarma.com/order/v2/department/{{departmentUUID}}/global_order/{{orderUUID}}"
-H "authorization: {{basic_auth_token}}"

Response


{
"statusCode":"string",
"orderReadChecksum":"string",
"errors":[

],
"warnings":[

],
"order":{
"uuid":"string",
"order":{
"type":"RO",
"header":{
"orderNumber":"string",
"serviceAccount":"string",
"accountingAccount":"string",
"dmsStatus":"string",
"status":"string",
"deptType":"string",
"advisorNumber":"string",
"advisorName":"string",
"dealerAssociateUuid":"string",
"originalAssociateUUID":"string",
"appointmentNumber":"string",
"tagNumber":"string",
"mileageIn":"string",
"mileageOut":"string",
"orderDate":"string",
"orderTime":"string",
"promisedDate":"string",
"promisedTime":"string",
"voidDate":"string",
"closeDate":"string",
"closeTime":"string",
"waiter":"string",
"rental":"string",
"soldHours":"string",
"actualHours":"string",
"laborCost":"string",
"laborSale":"string",
"laborSaleCustomer":"string",
"laborSaleInternal":"string",
"laborSaleWarranty":"string",
"partsCost":"string",
"partsCostCustomer":"string",
"partsCostInternal":"string",
"partsCostWarranty":"string",
"partsSale":"string",
"partsSaleCustomer":"string",
"partsSaleInternal":"string",
"partsSaleWarranty":"string",
"lubeSale":"string",
"lubeSaleCustomer":"string",
"lubeSaleInternal":"string",
"lubeSaleWarranty":"string",
"miscSale":"string",
"miscSaleCustomer":"string",
"miscSaleInternal":"string",
"miscSaleWarranty":"string",
"subletSale":"string",
"subletSaleCustomer":"string",
"subletSaleInternal":"string",
"subletSaleWarranty":"string",
"customerPayAmount":"string",
"customerPayStateTax":"string",
"warrantyPayStateTax":"string",
"internalPayStateTax":"string",
"internalPayAmount":"string",
"warrantyPayAmount":"string",
"invoiceURL":"string",
"payTypes":"string",
"description":"string",
"printDate":"string",
"printTime":"string",
"deliveryAmount":"string",
"estimate":"string",
"localTaxAmountCustomer":"string",
"localTaxAmountWarranty":"string",
"localTaxAmountInternal":"string",
"stockNumber":"string",
"isInternal":"string",
"isVoided":"string",
"invoiceTotal":"string",
"mykCreatedDate":"string"
},
"vehicle":{
"uuid":"string",
"vin":"string",
"make":"string",
"key":"string",
"model":"string",
"color":"string",
"licensePlate":"string"
},
"customer":{
"uuid":"string",
"key":"string",
"firstName":"string",
"lastName":"string"
},
"jobs":[
{
"jobIdentifier":"string",
"jobNumberString":"string",
"lopSeqNumber":"string",
"laborOpCode":"string",
"laborOpCodeDesc":"string",
"laborType":"string",
"laborSale":"string",
"soldHours":"string",
"actualHours":"string",
"partsSale":"string",
"miscSale":"string",
"bookerNo":"string",
"dispatchLineStatus":"string",
"techNo":"string",
"campaignCode":"string",
"estimates":{
"laborEstimate":"string",
"partsEstimate":"string",
"serviceEstimate":"string",
"taxEstimate":"string",
"lubeEstimate":"string",
"miscEstimate":"string",
"subletEstimate":"string"
},
"parts":[
{
"partNumber":"string",
"description":"string",
"seqNo":"string",
"quantityOrdered":"string",
"quantitySold":"string",
"cost":"string",
"salePrice":"string",
"saleTotal":"string",
"laborType":"string"
}
],
"gog":[
{
"itemType":"string",
"itemDescription":"string",
"jobNumber":"string",
"quantity":"string",
"saleTotal":"string",
"salePrice":"string",
"laborType":"string"
}
],
"techHours":[
{
"techNo":"string",
"partSeqNo":"string",
"laborCost":"string",
"laborSale":"string",
"soldHours":"string",
"otherHours":"string",
"laborType":"string"
}
],
"comments":[
{
"comment":"string",
"lastUpdatedBy":"string",
"updateDate":"string",
"updateTime":"string"
}
],
"ccc":{
"complaint":"string",
"complaintCode":"string",
"cause":"string",
"correction":"string"
}
}
],
"mls":[
{
"laborType":"string",
"opCode":"string",
"opCodeDesc":"string",
"failureCode":"string",
"salePrice":"string",
"costPrice":"string",
"saleCompany":"string",
"sourceCompany":"string",
"lineCode":"string",
"poNumber":"string",
"poCreateDate":"string",
"poLineID":"string",
"mlsType":"string"
}
]
}
}
}


Response Object Explanation

Parameter NameDescription
orderReadChecksumThe orderReadChecksum is a unique identifier used to verify the integrity and consistency of the order data retrieved from myKaarma. It should be included in follow-up update requests to ensure that the order data being modified is current and has not been altered since it was last read.

Parameter NameDescription
uuidunique identifier of Order in mykaarma.

Order Details

Parameter NameDescription
uuidunique identifier of Order in mykaarma.
type"RO" for service/repair order
orderNumberUnique identifier for the order. Ordernumber should match regex ^[a-zA-Z0-9-#_\s]*$
serviceAccountAccount associated with the service.
accountingAccountAccount used for accounting purposes.
statusCurrent status of the order in myKaarma. Possible values O/P/C signifying OPENED , PRE-INVOICED, CLOSED
dmsStatusCurrent status of the order in the DMS. Possible values O/P/C signifying OPENED , PRE-INVOICED, CLOSED. Check the documentation here for difference between this field and the status field above
deptTypeType of department handling the order.
advisorNumberIdentifier for the service advisor in the DMS to which RO is being assigned .
advisorNameName of the service advisor.
dealerAssociateUuidUnique token issued by mykaarma of the dealer associate to which RO is being assigned
originalAssociateUUIDUnique token issued by mykaarma of the dealer associate which is creating the RO.
appointmentNumberAppointment Number (generated in the DMS) associated with RO .
tagNumberIdentifier for the vehicle tag.
mileageInMileage of the vehicle when it arrived.
mileageOut Mileage of the vehicle when it left.
orderDateDate when the order was created. yyyy-MM-dd format in PST timezone
orderTimeTime when the order was created. HH:mm:ss in PST timezone
printDateThe date when the repair order was printed, formatted as yyyy-MM-dd in the PST timezone
printTimeThe time when the repair order was printed, formatted as HH:mm:ss in the PST timezone.
promisedDateDate by which the service is promised to be completed. yyyy-MM-dd format in PST timezone
promisedTimeTime by which the service is promised to be completed. HH:mm:ss format in PST timezone
voidDateDate when the order was voided. yyyy-MM-dd HH:mm:ss format in PST timezone
closeDateDate when the order was closed. yyyy-MM-dd format in PST timezone
closeTimeTime when the order was closed. HH:mm:ss format
waiterIndicates if the customer is waiting for the service. "Y/N"
rentalIndicates if a rental vehicle is provided. "Y/N"
soldHoursNumber of hours sold for the service.
actualHoursActual hours spent on the service.
laborCostCost of labor for the service. (Only numerics alowed upto 2 decimal places like "12.56" )
laborSaleSale amount for labor. (Only numerics alowed upto 2 decimal places like "12.56" )
laborSaleCustomerSale amount for labor charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
laborSaleInternalSale amount for internal labor. (Only numerics alowed upto 2 decimal places like "12.56" )
laborSaleWarrantySale amount for labor under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
partsCostCost of parts used in the service. (Only numerics alowed upto 2 decimal places like "12.56" )
partsCostCustomerCost of parts charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
partsCostInternalCost of parts for internal use. (Only numerics alowed upto 2 decimal places like "12.56" )
partsCostWarrantyCost of parts under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
partsSaleSale amount for parts. (Only numerics alowed upto 2 decimal places like "12.56" )
partsSaleCustomerSale amount for parts charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
partsSaleInternalSale amount for internal parts. (Only numerics alowed upto 2 decimal places like "12.56" )
partsSaleWarrantySale amount for parts under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
lubeSaleSale amount for lubricants. (Only numerics alowed upto 2 decimal places like "12.56" )
lubeSaleCustomerSale amount for lubricants charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
lubeSaleInternalSale amount for internal lubricants. (Only numerics alowed upto 2 decimal places like "12.56" )
lubeSaleWarrantySale amount for lubricants under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
miscSaleSale amount for miscellaneous items. (Only numerics alowed upto 2 decimal places like "12.56" )
miscSaleCustomerSale amount for miscellaneous items charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
miscSaleInternalSale amount for internal miscellaneous items. (Only numerics alowed upto 2 decimal places like "12.56" )
miscSaleWarrantySale amount for miscellaneous items under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
subletSaleSale amount for miscellaneous items under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
subletSaleCustomerSale amount for sublet services charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
subletSaleInternalSale amount for internal sublet services. (Only numerics alowed upto 2 decimal places like "12.56" )
subletSaleWarrantySale amount for sublet services under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )
customerPayAmountTotal amount payable by the customer. (Only numerics alowed upto 2 decimal places like "12.56" )
customerPayStateTaxThe state tax amount payable by the customer, formatted as a numeric value up to two decimal places (e.g., "12.56").
warrantyPayStateTaxThe state tax amount covered by the warranty, formatted as a numeric value up to two decimal places (e.g., "12.56").
internalPayStateTaxThe state tax amount covered by internal charges, formatted as a numeric value up to two decimal places (e.g., "12.56").
localTaxAmountCustomerThe local tax amount payable by the customer, formatted as a numeric value up to two decimal places (e.g., "12.56").
localTaxAmountWarrantyThe local tax amount covered by the warranty, formatted as a numeric value up to two decimal places (e.g., "12.56").
localTaxAmountInternalThe local tax amount covered by internal charges, formatted as a numeric value up to two decimal places (e.g., "12.56").
isInternalIndicates whether the repair order is for internal purposes, typically represented as a boolean value (e.g., "true" or "false").
isVoidedIndicates whether the repair order has been voided, typically represented as a boolean value (e.g., "true" or "false").
invoiceTotalThe total amount of the invoice, formatted as a numeric value up to two decimal places (e.g., "12.56").
mykCreatedDateThe date when the order was created in myKaarma, formatted as yyyy-MM-dd. PST timezone
stockNumberThe identifier for the vehicle's stock, typically used for inventory management.
invoiceURLThe URL link to access the invoice associated with the repair order.
payTypesThe different methods or categories of payment applicable to the repair order.
estimateEstimate of the order
internalPayAmountTotal internal charges, formatted as a numeric value up to two decimal places (e.g., "12.56").
warrantyPayAmountTotal amount covered by the warranty, formatted as a numeric value up to two decimal places (e.g., "12.56").
descriptionDescription of the order.

Vehicle Information

Parameter NameDescription
vehicle.uuidUnique identifier issued by mykaarma for the vehicle for which the order is being created.
vehicle.vinVehicle Identification Number for the vehicle for which the order is being created .
vehicle.makeManufacturer of the vehicle the order is being created.
vehicle.modelModel of the vehicle.
vehicle.keyModel of the vehicle.
vehicle.colorModel of the vehicle.
vehicle.licensePlateModel of the vehicle.

Customer Information

Parameter NameDescription
customer.uuidUnique identifier issued by mykaarma for the customer for which the order is being created.
customer.firstNameFirst name of the customer.
customer.lastNameLast name of the customer.
customer.keyUnique identifier issued by mykaarma for the customer for which the order is being created.

Job details

Parameter NameDescription
job.jobIdentifierUnique identifier for the line + labor operation. Example "A-1","B-2"
job.jobNumberStringUnique identifier for the line. Example "A","B","C"
job.lopSeqNumberSequence number for the labor operation. Example "1","2" ,"3"
job.laborOpCodeCode for the labor operation. Example "OIL"
job.laborOpCodeDescDescription of the labor operation.
job.laborTypeType of labor performed. Perferred allowed values are C/W/I
job.dmsLaborTypeThe type of labor performed as recorded in the Dealer Management System (DMS)
job.serviceTypeThe type of service performed
job.jobTotalThe total cost associated with a specific job, formatted as a numeric value up to two decimal places (e.g., "12.56").
job.shopChargeThe charge associated with shop supplies or services, formatted as a numeric value up to two decimal places (e.g., "12.56").
job.complaintCodeA code representing the type or category of the customer's complaint.
job.addOnLineIndicates additional labor or services added to the repair order, with preferred allowed values being Y/N
job.partsFlag
job.dispatchEstimatedDurationType of labor performed. Perferred allowed values are C/W/I
job.comeBackFlagIndicates whether the repair order is a comeback, typically represented as a boolean value (e.g., "true" or "false")./ ("Y" , "N")
job.laborSaleSale amount for the labor.(Only numerics alowed upto 2 decimal places like "12.56" )
job.soldHoursNumber of hours sold for the job.
job.actualHoursActual hours spent on the job.
job.partsSaleSale amount for parts used in the job. (Only numerics alowed upto 2 decimal places like "12.56" )
job.miscSaleSale amount for miscellaneous items in the job. (Only numerics alowed upto 2 decimal places like "12.56" )
job.bookerNoBooker number for the job.
job.dispatchLineStatusStatus of the dispatch line.
job.techNoIdentifier for the technician in the DMS who performed the job.
job.campaignCodeCode for any applicable campaign.

Estimate Information

Parameter NameDescription
estimate.laborEstimateThe estimated cost of labor for the job , formatted as a numeric value up to two decimal places (e.g., "12.56").
estimate.partsEstimateThe estimated cost of parts for the repair order, formatted as a numeric value up to two decimal places.
estimate.serviceEstimateThe estimated cost of services for the repair order, formatted as a numeric value up to two decimal places (e.g., "12.56").
estimate.taxEstimateThe estimated tax amount for the repair order, formatted as a numeric value up to two decimal places (e.g., "12.56").
estimate.lubeEstimateThe estimated cost of lubricants for the repair order, formatted as a numeric value up to two decimal places (e.g., "12.56").
estimate.miscEstimateThe estimated cost of miscellaneous items for the repair order, formatted as a numeric value up to two decimal places (e.g., "12.56").
estimate.subletEstimateThe estimated cost of sublet services for the repair order, formatted as a numeric value up to two decimal places (e.g., "12.56").

Parts Information

Parameter NameDescription
part.partNumberNumber identifying the part.
part.descriptionDescription of the part.
part.seqNoSequence number for the part.
part.quantityOrderedQuantity of the part ordered.
part.quantitySoldQuantity of the part sold.
part.quantityShippedQuantity of the part shipped.
part.quantityAvailableQuantity of the part available.
part.listPriceThe manufacturer's suggested retail price (MSRP) for the part, formatted as a numeric value up to two decimal places (e.g., "12.56").
part.extendedSalePriceThe total sale amount for the part, calculated by multiplying the sale price by the quantity sold, formatted as a numeric value up to two decimal places.
part.sourceThe origin or supplier of the part, indicating where it was obtained or purchased from.
part.partSaleJournalA record of the sales transactions for the part, typically used for tracking and accounting purposes.
part.partSaleCompanyThe company responsible for the sale of the part, typically used for accounting and inventory management purposes.
part.specStatusThe status indicating the specifications or condition of the part, typically used for inventory management and tracking.
part.partCoreAccountAn account used to track the core charge associated with the part, typically related to the return of a used part for credit.
part.partSaleAccountAn account used to record the sales transactions of the part, typically for accounting and inventory management purposes.
part.mcdPartsPercentageThe percentage of the part's cost that is covered under the manufacturer's core deposit program, typically represented as a numeric value.
part.binNumberThe location identifier for the part within the inventory storage system, used for efficient tracking and retrieval.
part.unitServiceChargeThe charge associated with the service provided for the part, typically formatted as a numeric value up to two decimal places (e.g., "12.56").
part.mfrCodeThe manufacturer's code associated with the part, used for identification and tracking purposes.
part.includesCoreFlagIndicates whether the part includes a core charge, typically represented as a boolean value (e.g., "true" or "false").
part.costCost of the part.
part.salePriceSale price of the part.
part.saleTotalTotal sale amount for the part.
part.laborTypeType of labor associated with the part.

GOG Information

Parameter NameDescription
gog.itemTypeType of item in the GOG.
gog.itemDescriptionDescription of the item.
gog.jobNumberJob number associated with the item.
gog.quantityQuantity of the item.
gog.saleTotalTotal sale amount for the item.
gog.salePriceSale price of the item.
gog.salePriceSale price of the item.
gog.laborTypeType of labor associated with the item.

Tech Hours

Parameter NameDescription
tech.techNoIdentifier for the technician in the DMS who performed the job.
tech.techUuidIdentifier for the technician in the myKaarma who performed the job.
tech.mcdLaborPercentageThe percentage of labor costs covered under the manufacturer's core deposit program, typically represented as a numeric value.
tech.timeCardHoursThe total hours recorded for the technician's work on the job, typically represented as a numeric value.
tech.partSeqNoSequence number for the part, used to identify the order of parts in the repair order.
tech.laborCostCost of labor for the technician.
tech.laborSaleSale amount for the labor.
tech.soldHoursNumber of hours sold for the technician's work.
tech.otherHoursAdditional hours associated with the technician's work.
tech.laborTypeType of labor performed by the technician.

Comments

Parameter NameDescription
comments.commentText of the comment.
comments.lastUpdatedByIdentifier for the person who last updated the comment.
comments.updateDateDate when the comment was last updated. yyyy-MM-dd format UTC timezone
comments.updateTimeTime when the comment was last updated. HH:mm:ss format UTC timezone

Complaint cause correction

Parameter NameDescription
ccc.complaintDescription of the customer's complaint.
ccc.complaintCodeCode for the complaint.
ccc.causeCause of the job.
ccc.correctionCorrection made to address the complaint.

MLS Information

Parameter NameDescription
mls.laborTypeType of labor in the MLS.
mls.opCodeOperation code in the MLS.
mls.opCodeDescDescription of the operation code.
mls.failureCodeCode for any failure.
mls.salePriceSale price in the MLS..
mls.costPriceCost price in the MLS.
mls.saleCompanyCompany responsible for the sale.
mls.sourceCompanyCompany that sourced the item.
mls.lineCodeCode for the line item.
mls.poNumberPurchase order number.
mls.poCreateDateDate when the purchase order was created.
mls.poLineIDLine ID for the purchase order.
mls.mlsTypeType of MLS entry.
mls.debitAccountThe account used to record debits associated with the transaction, typically for accounting purposes.
mls.debitCompanyThe company associated with the debit transaction, typically used for accounting and financial tracking.
mls.debitControlThe type of control associated with the debit transaction, typically used for accounting purposes.
mls.feeIDA unique identifier for the fee associated with the transaction, used for tracking and accounting purposes.
mls.saleAccountAn account used to record the sales transactions associated with the repair order, typically for accounting and inventory management purposes.
mls.saleControlThe type of control associated with the sale transaction, typically used for accounting purposes.

Order Status & DMS Status Information

Status NameDescription
OOPEN - The repair order is currently active and work is ongoing.
PPRE_INVOICED - The repair order is in the final review stage before billing.
CCLOSED - The repair order is completed and all services have been finalized.

Important Note

Order status and dmsStatus can have different values over the complete lifecycle of a Service order.