Message Format
The message should be formatted as RFC 8259 compliant JSON and sent as a POST to the correct environment endpoint as specified in the documentation.
An example POST is shown in the Example cURL commands page.
The format broadly follows conventions and code lists established by CIECA - a CAPIS API will be available as a future version of this API. For more detail on the accepted values in {{type}} fields, see the CIECA code lists, BMS standards, or contact neil@bodyshopbooster.com
Β
Further details are shown below:
1. customerInfo (Customer Information)
firstName: The first name of the customer.lastName: The last name of the customer.phoneNums: A list of phone numbers associated with the customer.phoneNum: The customer's phone number.phoneNumExtension: The extension or country code of the phone number.type: The type of phone number (e.g., "CP" for cell phone).
emails: A list of email addresses for the customer.email: The customer's email address.type: The type of email address (e.g., "EM" for email).
address: The customer's address details.address1: Primary street address.address2: Additional address details (e.g., apartment number).city: The city where the customer resides.stateProvince: The state or province of the customer.countryCode: The country code of the address.postalCode: The postal or ZIP code.
companyName: The name of the company associated with the customer (if applicable).
2. vehicleInfo (Vehicle Information)
vehicleDesc: Describes the vehicle details.vin: Vehicle Identification Number (VIN).modelYear: The year the vehicle was manufactured.makeDesc: The make or brand of the vehicle.modelName: The model name of the vehicle.arrivalOdometerReading: Odometer reading when the vehicle arrived at the service center.departureOdometerReading: Odometer reading when the vehicle was picked up after service.trimCode: The trim level or variant of the vehicle.
license: License plate information.licensePlateNum: The vehicle's license plate number.licensePlateStateProvince: The state or province where the license plate was issued.
paint: Vehicle paint details.interior: Interior paint details.interiorColorCode: The color code for the vehicle's interior.color: The name of the interior color.
exterior: Exterior paint details.exteriorColorCode: The color code for the vehicle's exterior.color: The name of the exterior color.
condition: Information about the vehicle's condition.drivableInd: Indicates whether the vehicle is drivable (true/false).windshieldCrackedInd: Indicates if the windshield is cracked (true/false).airbagDeployedInd: Indicates if the airbag has been deployed (true/false).
transmissionDesc: A description of the vehicle's transmission type.
3. insurerInfo (Insurance Information)
refClaimNum: Reference claim number assigned by the insurer.priceEstimate: Estimated cost of repairs.policyNum: Insurance policy number.adjuster: Name of the insurance adjuster handling the claim.phoneNums: Contact details for the insurer.phoneNum: The phone number of the insurer.phoneNumExtension: The extension or country code.type: The type of phone number (e.g., "CP" for cell phone).
emails: Email addresses associated with the insurer.email: The insurer's email address.type: The type of email (e.g., "EM" for email).
address: The address of the insurer.address1: Primary street address.address2: Additional address details.city: City where the insurer is located.stateProvince: State or province.countryCode: Country code of the insurer.postalCode: Postal or ZIP code.
companyName: Name of the insurance company.companyUrl: Website of the insurance company.
4. repairInfo (Repair Information)
id: Unique identifier for the repair record.documentId: optional additional ID for the associated repair document.partnerId: ID of the repair partner handling the repair.roNumber: Repair Order (RO) number.workFileId: Identifier for the work file related to the repair.claimInfo: Information about the insurance claim related to the repair.lossDateTime: The date and time of the incident that caused the damage.repairDuration: Estimated duration for repair in days.poiCode: Point of impact code describing the damage location.fNOLDateTime: First Notice of Loss (FNOL) date and time.reportedDateTime: Date and time the incident was reported.inspectionSite: Location where the vehicle inspection took place.inspectionDateTime: Date and time of vehicle inspection.
quickSurveyScore: Customer satisfaction survey score for the repair process.repairOrderType: Type of repair order (e.g., warranty, collision, etc.).paymentInfo: Information related to payment for the repair.documentInfo: Information about repair documents.createDateTime: Date and time when the document was created.
5. repairEvent (Repair Timeline)
See Dates & Statuses in BodyShop Booster - scheduled dates are shown for info only, actual dates can update the current status of the repair record.
Send dates in format : 2025-03-07T11:18:40.000Z
Actual Dates
actualCreateDateTime : the date the record was created - this will be filled in Booster but can be overridden via API
actualStartDate: the date the repair is started
actualEstimateSentDateTime: the date the estimate is sent to the customer for review
actualCompletionDateTime: the date the repairs complete
actualEstimateApprovedDateTime: the date the customer approves the estimate
actualBookingMadeDateTime: the date the customer made the booking
actualPickupDateTime
arrivalDateTime
closedDateTime
Β
Scheduled Dates
scheduledStartDateTime
scheduledEstimateSentDateTime
scheduledBookingMadeDateTime: the
scheduledCompletionDateTime
scheduledEstimateApprovedDateTime
scheduledPickupDateTime
scheduledArrivalDateTime
scheduledCloseDateTime
Β
6. estimateInfo (Repair Estimate Information)
estimateType: The type of estimate (e.g., preliminary, final).repairTotalsInfo: Summary of repair costs.summaryTotalsInfo: List of total cost breakdowns.type: Type of total cost (e.g., "TOT" for total).subType: Subcategory of the total cost (e.g., "T2").totalAmt: The total amount for this category.
laborTotalsInfo: Labor cost breakdown.type: Type of labor cost (e.g., "LAP" for PDR Labor, βLARβ for Paint / Refinsh Labor).totalHours: Total labor hours.totalAmt: Total labor cost.
taxTotalAmt: Total tax amount.totalTaxPercentage: Tax percentage applied to the estimate.previousPaymentAmt: Amount of any previous payments made.
7. estimatorInfo (Estimator Details)
firstName: First name of the estimator who prepared the estimate.lastName: Last name of the estimator.previous payments made.
8. customFieldsInfo (Custom Field Details)
9. links (Links)
See Links