How to create an order for Parts Department

This document is designed to help you understand how you can create a Parts Order for the Parts Department. The endpoint enables users to submit a new repair order with various parameters like orderDate, closeDate, orderNumber, etc.. The created 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. The endpoint mentioned below can assist you in creating a Repair Order with customized parameters :-

Parameters Used

Path parameters

Parameter Name	Value	Description	Required
`departmentUUID`	`String`	Unique identifier of dealer department	Yes

Authorization

Parameter Name	Description	Required
`{{basic_auth_token}}`	Authorization: Base64 encoded string using Service Subscriber Username and password	Yes

Scope

This request requires the following authorization scopes:

Scope	Level	Description
`order.create`	`DealerDepartment`	Authorizes client to create parts order for provided user's dealer department

Endpoint

curl -X PUT "https://api.mykaarma.com/order/v2/department/{{departmentUUID}}/order/"
-H "authorization: {{basic_auth_token}}"
-d '{
    "order":{
      "type":"RO",
      "header":{
         "orderNumber":"string",
         "serviceAccount":"string",
         "accountingAccount":"string",
         "status":"string",
         "deptType":"string",
         "advisorNumber":"string",
         "advisorName":"string",
         "assignedUserUuid":"string",
         "creatorUserUuid":"string",
         "appointmentNumber":"string",
         "tagNumber":"string",
         "mileageIn":"string",
         "mileageOut":"string",
         "createDate":"string",
         "createTime":"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",
         "internalPayAmount":"string",
         "warrantyPayAmount":"string",
         "description":"string"
      },
      "vehicle":{
         "uuid":"string",
         "vin":"string",
         "make":"string",
         "model":"string",
      },
      "customer":{
         "uuid":"string",
         "firstName":"string",
         "lastName":"string"
      },
      "parts" :[
        {
            "partNumber": "string",
            "description": "string",
            "seqNo": "string",
            "quantityOrdered": "string",
            "quantitySold": "string",
            "cost": "string",
            "salePrice": "string",
            "saleTotal": "string",
            "laborType": "string"
        }
      ]
    }
}'

Response

{
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningDescription": "string"
    }
  ],
  "orderUUID": "string",
  "statusCode": "Integer"
}

Request Body

Order Details

Parameter Name	Description	Required	Field Length
`type`	"RO" for service/repair order	Yes	2
`orderNumber`	Unique identifier for the order. Ordernumber should match regex ^[a-zA-Z0-9-#_\s]*$	Yes	75
`serviceAccount`	Account associated with the service in the DMS.	No	20
`accountingAccount`	Account used for accounting purposes in the DMS.	No	20
`status`	Current status of the order .	Yes ( allowed values are `OPENED`, `PRE-INVOICED`, `CLOSED` )	50
`deptType`	Type of department handling the order.	No	20
`advisorNumber`	Identifier for the service advisor in the DMS to which RO is being assigned.	No( only required if `assignedUserUuid` is blank)	20
`advisorName`	Name of the service advisor.	No	90
`assignedUserUuid`	Unique token issued by mykaarma of the dealer associate to which RO is being assigned	No( Required Only if `advisorNumber` is blank )	-
`creatorUserUuid`	Unique token issued by mykaarma of the dealer associate which is creating the RO.	No	-
`appointmentNumber`	Appointment Number (generated in the DMS) associated with RO.	No	100
`tagNumber`	Identifier for the vehicle tag.	No	45
`mileageIn`	Mileage of the vehicle when it arrived.	No	30
`mileageOut`	Mileage of the vehicle when it left.	No	30
`createDate`	Date when the order was created. yyyy-MM-dd format in UTC timezone	Yes	-
`orderTime`	Time when the order was created. HH:mm:ss in UTC timezone	Yes	-
`promisedDate`	Date by which the service is promised to be completed. yyyy-MM-dd format in UTC timezone	No	-
`promisedTime`	Time by which the service is promised to be completed. HH:mm:ss format in UTC timezone	No	-
`voidDate`	Date when the order was voided. yyyy-MM-dd HH:mm:ss format in UTC timezone.	No	-
`closeDate`	Date when the order was closed. yyyy-MM-dd format in UTC timezone	No	-
`closeTime`	Time when the order was closed. HH:mm:ss format	No	-
`waiter`	Indicates if the customer is waiting for the service. "Y" /"N"	No	1
`rental`	Indicates if a rental vehicle is provided. "Y"/"N"	No	1
`soldHours`	Number of hours sold for the service.	No	10
`actualHours`	Actual hours spent on the service.	No	10
`laborCost`	Cost of labor for the service. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`laborSale`	Sale amount for labor. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`laborSaleCustomer`	Sale amount for labor charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`laborSaleInternal`	Sale amount for internal labor. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`laborSaleWarranty`	Sale amount for labor under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsCost`	Cost of parts used in the service. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsCostCustomer`	Cost of parts charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsCostInternal`	Cost of parts for internal use. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsCostWarranty`	Cost of parts under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsSale`	Sale amount for parts. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsSaleCustomer`	Sale amount for parts charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsSaleInternal`	Sale amount for internal parts. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`partsSaleWarranty`	Sale amount for parts under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`lubeSale`	Sale amount for lubricants. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`lubeSaleCustomer`	Sale amount for lubricants charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`lubeSaleInternal`	Sale amount for internal lubricants. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`lubeSaleWarranty`	Sale amount for lubricants under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`miscSale`	Sale amount for miscellaneous items. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`miscSaleCustomer`	Sale amount for miscellaneous items charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`miscSaleInternal`	Sale amount for internal miscellaneous items. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`miscSaleWarranty`	Sale amount for miscellaneous items under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`subletSale`	Sale amount for miscellaneous items under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`subletSaleCustomer`	Sale amount for sublet services charged to the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`subletSaleInternal`	Sale amount for internal sublet services. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`subletSaleWarranty`	Sale amount for sublet services under warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`customerPayAmount`	Total amount payable by the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`customerPayStateTax`	State tax amount payable by the customer. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`internalPayAmount`	Total internal charges. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`warrantyPayAmount`	Total amount covered by warranty. (Only numerics alowed upto 2 decimal places like "12.56" )	No	10
`description`	Description of the order.	No	800

Vehicle Information

Parameter Name	Description	Required
`vehicle.uuid`	Unique identifier issued by mykaarma for the vehicle for which the order is being created.	No
`vehicle.vin`	Vehicle Identification Number for the vehicle for which the order is being created .	No
`vehicle.make`	Manufacturer of the vehicle the order is being created.	No
`vehicle.model`	Model of the vehicle.	No

Customer Information

Parameter Name	Description	Required
`customer.uuid`	Unique identifier issued by mykaarma for the customer for which the order is being created. To obtain this, use the Create or update customer with search for duplicates API.	Yes
`customer.firstName`	First name of the customer.	No
`customer.lastName`	Last name of the customer.	No

Parts Information

Parameter Name	Description	Required
`part.partNumber`	Number identifying the part.	Yes
`part.description`	Description of the part.	No
`part.seqNo`	Sequence number for the part.	No
`part.quantityOrdered`	Quantity of the part ordered.	No
`part.quantitySold`	Quantity of the part sold.	No
`part.cost`	Cost of the part.	No
`part.salePrice`	Sale price of the part.	No
`part.saleTotal`	Total sale amount for the part.	No
`part.laborType`	Type of labor associated with the part.	No

Response Object Explanation

{{orderUUID}} uuid of the order which was created/updated .

{{errors}} An array of error objects detailing issues encountered during order creation or update.

{{warnings}} An array of warning objects providing non-critical alerts encountered during customer creation or update.

{{errors.errorCode}} Code indicating the specific error encountered during order creation or update; refer to the API reference for a list of possible error codes.

{{errors.errorTitle}} Title describing the specific error encountered during order creation or update; refer to the API reference for detailed descriptions.

{{errors.errorDescription}} Detailed message describing the specific error encountered during order creation or update; refer to the API reference for more information.

{{warnings.warningCode}} Code indicating the specific warning encountered during order creation or update; refer to the API reference for a list of possible warning codes.

{{warnings.warningDescription}} Detailed message describing the specific warning encountered during order creation or update; refer to the API reference for more information.

Parameters Used​

Path parameters​

Authorization​

Scope​

Endpoint​

Response​

Request Body​

Order Details​

Vehicle Information​

Customer Information​

Parts Information​

Response Object Explanation​