Truck Care API v1
home
Purpose
This API provides the ability to request truck care service from Love's by providing information on the customer, their location, and the services they require.
Additional configuration exists in the backend to help ensure your service requests are handled how you expect them to be, which can be ironed out during onboarding.
Receiving Updates on Your Request(s)
We have additional services on the backend that can send out updates to your system once the service provided hits various milestones (Technician Departed Store, Technician Arrived, etc). We can send any service request information plus any images taken during the service event back to you.
As part of onboarding, we can work with you to ensure these outbound updates are handled as expected.
Routes
/serviceRequests
POST /serviceRequests
- Creates a service request within Love's ecosystem
- Returns a service request number
Request
{
"driver": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@test.com",
"phoneNumber": "5555555555",
"streetAddress": "123 Test Ave",
"city": "Example City",
"state": "Oklahoma",
"zipCode": "12345",
"loyaltyCard": 77785012345678,
"dispatchPhone": "5555555555"
},
"vehicle": {
"color": "dark blue",
"DOT": "string",
"licensePlateNumber": "A6G4HR",
"licensePlateState": "Oklahoma",
"make": "Mack",
"model": "E Series",
"number": "A-1254",
"trailerNumber": "string",
"truckNumber": "string",
"type": "Truck",
"VIN": "1HGBH41JXMN109186",
"year": "1936"
},
"fleet": {
"name": "Doe's Logistics",
"state": "Oklahoma",
"city": "Example City",
"zipCode": "12345",
"mainEmail": "john.doe@test.com",
"dotNumber": 80806,
"fleetIdentifierType": "Michelin",
"fleetIdentifierNumber": "1234567"
},
"lineItems": [
{
"complaintType": "Tire Replacement",
"externalLineItemNumber": "LI-00054321",
"tirePosition": "LF",
"wheelPosition": "All Position",
"tireDOT": "D00001",
"treadDepthInMm": 80,
"paymentType": "NA - Michelin",
"paymentNumber": "MA-92837474",
"poNumber": "1234",
"referenceNumber": "1234",
"preferredProduct": {
"productDescription": "215/75R15 XDT 180",
"productCode": "999-999-999",
"tireBrand": "Michelin",
"tireSize": "275/80R22.5",
"tireTread": "XD2",
"tireType": "Drive"
}
}
],
"serviceInformation": {
"serviceType": "Roadside",
"highway": "I-35",
"mileMarker": "MM50",
"latitude": 35.231,
"longitude": -31.29032,
"storeNumber": 300,
"etaHours": 1,
"etaMinutes": 34,
"etaDatetime": "2020-10-18T08:05:22.090Z",
"technician": "John Doe",
"serviceLocationDescription": "I-35, mile marker 123",
"status": "New"
},
"requestInformation": {
"subject": "Tire Replacement Breakdown",
"partnerReferenceNumber": "ABCD",
"poNumber": "81172",
"origin": "Phone",
"caseNumber": "0012345",
"notes": "example notes provided"
}
}PUT /serviceRequests/{id}
- Updates an existing service request
- Only allows a subset of information to be updated
- Can be called by leveraging the Love's service request number or your own internal request number
Request
{
"status": "ETA Approved",
"notes": "example notes provided",
"driver": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@test.com",
"phoneNumber": "5555555555",
"streetAddress": "123 Test Ave",
"city": "Example City",
"state": "Oklahoma",
"zipCode": "12345"
},
"vehicle": {
"truckNumber": "string"
},
"payment": {
"paymentType": "NA - Michelin",
"paymentNumber": "MA-92837474"
}
}DELETE /serviceRequests/{id}
- Cancels an existing service request
Request
{
"reason": "ETA Too Long",
"notes": "ETA was longer than expected"
}