Vehicle
A Vehicle object is a specific instance of a vehicle for your Customer. A Vehicle typically will have a Vehicle Identification Number (VIN) and License Plate as well as describe other sepcific characteristics as the the license plate State or Providence, mileage, etc.
Find Customer Vehicles
Returns an array of vehicles assigned to the passed in customer ID
URL parameters
- Name
id
- Type
- string Required
- Description
- The customer id
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
meta
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/customer/ID/vehicle \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationIds": [
"locationIds"
],
"baseId": null,
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"engineId": null,
"productionDate": null,
"transmission": null,
"transmissionId": null,
"transmissionSpeed": null,
"transmissionMfrCode": null,
"drivetrain": null,
"drivetype": null,
"drivetypeId": null,
"bodyStyle": null,
"bodyStyleId": null,
"bedLength": null,
"configurationStatus": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"computed_ymm": null,
"customPhoto": true,
"stockPhoto": true,
"externalId": null,
"originLocationId": null,
"imported": true,
"length": null,
"lengthUnit": null,
"hin": null,
"serial": null,
"name": null,
"coalescedVINorHIN": null,
"lastServicedDate": null,
"frontTireSize": null,
"rearTireSize": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null
}
],
"success": true
}
Find Vehicle
Find one Vehicle by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object to retrieve
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- object Required
- Description
- Vehicle schema
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
meta
- Type
- object Required
- Description
- the metadata about the most recent change to the row
- Name
metadata
- Type
- object
- Description
- metadata reserved for customers to control
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engines
- Type
- array
- Description
- Name
tirePressureLogs
- Type
- array Required
- Description
- Name
labelConnections
- Type
- array Required
- Description
- Name
mileageLogs
- Type
- array Required
- Description
- Name
connectedLocationIds
- Type
- array
- Description
Properties for meta
object
- Name
userId
- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId
- Type
- string
- Description
- the session id for the most recent change
- Name
version
- Type
- number
- Description
- a monotonically increasing number for the most recent change
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"customFields": {},
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null,
"order": {
"number": 1
}
}
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"mileageLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"type": "type",
"mileage": 1,
"mileageDate": "mileageDate",
"vehicleId": "vehicleId",
"orderId": null,
"order": {
"number": 1
}
}
]
}
}
Export Vehicles
Export Vehicle data as Excel spreadsheet
Produces
The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
the data in excel format
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/export \
-H "Authorization: Bearer ${SM_TOKEN}"
Export Vehicles
Export Vehicle data as Excel spreadsheet
Produces
The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
the data in excel format
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/export \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Import entities
Import one or more entities
Body parameters
Consumes
The following content type is required: multipart/form-data
- Name
entityType
- Type
- object
- Description
- Name
file
- Type
- undefined Required
- Description
- a multipart mime data payload in Microsoft Excel (xlsx) format
Properties for entityType
object
- Name
value
- Type
- string Required
- Description
- the entity name to import data to
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
Properties for data
object
- Name
added
- Type
- number Required
- Description
- number of records created
- Name
updated
- Type
- number Required
- Description
- number of records updated
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestmultipart/form-data
curl https://api.shopmonkey.cloud/v3/vehicle/import \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: multipart/form-data' \
--data '{}'
Example Responseapplication/json
{}
Update Vehicle
Update a Vehicle
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the vehicle
Body parameters
Consumes
The following content type is required: application/json
- Name
locationIds
- Type
- array
- Description
- Name
baseId
- Type
- integer
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon
- Description
- Name
year
- Type
- integer
- Description
- Name
make
- Type
- string
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer
- Description
- vcdb make id
- Name
model
- Type
- string
- Description
- Name
modelId
- Type
- integer
- Description
- vcdb model id
- Name
submodel
- Type
- string
- Description
- Name
submodelId
- Type
- integer
- Description
- vcdb submodel id
- Name
engine
- Type
- string
- Description
- Name
engineId
- Type
- integer
- Description
- vcdb engine id
- Name
productionDate
- Type
- string
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch
- Description
- Name
transmissionId
- Type
- integer
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string
- Description
- Name
transmissionMfrCode
- Type
- string
- Description
- Name
drivetype
- Type
- string
- Description
- Name
drivetypeId
- Type
- integer
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string
- Description
- Name
bodyStyleId
- Type
- integer
- Description
- vcdb body style id
- Name
bedLength
- Type
- string
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid
- Description
- Name
vin
- Type
- string
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other
- Description
- Name
unit
- Type
- string
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer
- Description
- Name
odometer
- Type
- boolean
- Description
- Name
licensePlate
- Type
- string
- Description
- Name
licensePlateState
- Type
- string
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW
- Description
- Name
note
- Type
- string
- Description
- Name
customFields
- Type
- object
- Description
- custom field values
- Name
labels
- Type
- undefined
- Description
- Name
externalId
- Type
- string
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string
- Description
- the location that created the vehicle
- Name
length
- Type
- number
- Description
- Name
lengthUnit
- Type
- one of: Ft, M
- Description
- Name
hin
- Type
- string
- Description
- Vessel hull identification number
- Name
serial
- Type
- string
- Description
- Name
name
- Type
- string
- Description
- Custom vehicle name / Vessel registered name
- Name
frontTireSize
- Type
- string
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe
- Description
- Name
deleted
- Type
- boolean
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string
- Description
- the user that deleted the record or null if not deleted
- Name
deletedReason
- Type
- string
- Description
- the reason that the record was deleted
- Name
drivetrain
- Type
- one of: 'AWD', 'FWD', 'RWD', '4WD', 'FourWD', null
- Description
- Name
engines
- Type
- array
- Description
- Name
mileage
- Type
- number
- Description
- the mileage for the vehicle
- Name
vcdbId
- Type
- number
- Description
- the id for the VCDB vehicle
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true
}
}
Update Custom Fields
Update a Vehicle's custom fields
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the vehicle
Body parameters
Consumes
The following content type is required: application/json
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
Properties for data
object
- Name
id
- Type
- string Required
- Description
- the id for the object
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID/customfield \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id"
}
}
Link Vehicle
Link a Vehicle
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the vehicle
Body parameters
Consumes
The following content type is required: application/json
- Name
vcdbId
- Type
- number Required
- Description
- the id for the VCDB vehicle
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID/link \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "vcdbId" : 0 }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"customFields": {}
}
}
Create Vehicle
Create a new Vehicle
Body parameters
Consumes
The following content type is required: application/json
- Name
locationIds
- Type
- array
- Description
- Name
baseId
- Type
- integer
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon
- Description
- Name
year
- Type
- integer
- Description
- Name
make
- Type
- string
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer
- Description
- vcdb make id
- Name
model
- Type
- string
- Description
- Name
modelId
- Type
- integer
- Description
- vcdb model id
- Name
submodel
- Type
- string
- Description
- Name
submodelId
- Type
- integer
- Description
- vcdb submodel id
- Name
engine
- Type
- string
- Description
- Name
engineId
- Type
- integer
- Description
- vcdb engine id
- Name
productionDate
- Type
- string
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch
- Description
- Name
transmissionId
- Type
- integer
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string
- Description
- Name
transmissionMfrCode
- Type
- string
- Description
- Name
drivetype
- Type
- string
- Description
- Name
drivetypeId
- Type
- integer
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string
- Description
- Name
bodyStyleId
- Type
- integer
- Description
- vcdb body style id
- Name
bedLength
- Type
- string
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid
- Description
- Name
vin
- Type
- string
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other
- Description
- Name
unit
- Type
- string
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer
- Description
- Name
odometer
- Type
- boolean
- Description
- Name
licensePlate
- Type
- string
- Description
- Name
licensePlateState
- Type
- string
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW
- Description
- Name
note
- Type
- string
- Description
- Name
customFields
- Type
- object
- Description
- custom field values
- Name
labels
- Type
- undefined
- Description
- Name
externalId
- Type
- string
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string
- Description
- the location that created the vehicle
- Name
length
- Type
- number
- Description
- Name
lengthUnit
- Type
- one of: Ft, M
- Description
- Name
hin
- Type
- string
- Description
- Vessel hull identification number
- Name
serial
- Type
- string
- Description
- Name
name
- Type
- string
- Description
- Custom vehicle name / Vessel registered name
- Name
frontTireSize
- Type
- string
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe
- Description
- Name
deleted
- Type
- boolean
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string
- Description
- the user that deleted the record or null if not deleted
- Name
deletedReason
- Type
- string
- Description
- the reason that the record was deleted
- Name
drivetrain
- Type
- one of: 'AWD', 'FWD', 'RWD', '4WD', 'FourWD', null
- Description
- Name
customerId
- Type
- string
- Description
- the id for the customer
- Name
engines
- Type
- array
- Description
- Name
mileage
- Type
- number
- Description
- the mileage for the vehicle
- Name
vcdbId
- Type
- number
- Description
- the id for the VCDB vehicle
- Name
locationId
- Type
- string
- Description
- the id for the location
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "size" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"customFields": {}
}
}
Soft Delete Vehicle
Soft delete or undelete a Vehicle by id
URL parameters
- Name
action
- Type
- one of: 'delete', 'undelete' Required
- Description
- the action to take
- Name
id
- Type
- string Required
- Description
- primary key for the record
Body parameters
Consumes
The following content type is required: application/json
- Name
reason
- Type
- string Required
- Description
- the reason message if deleted
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID/ACTION \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PATCH -H 'Content-Type: application/json' \
--data '{ "reason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"computed_ymm": null,
"customPhoto": true,
"stockPhoto": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"customFields": {}
}
}
Find Years
Find all Vehicle years
URL parameters
- Name
region
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
vehicleGroup
- Type
- one of: any, 'All' Required
- Description
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Array of years sorted by most recent to oldest
- Name
success
- Type
- boolean Required
- Description
- Returns true if the request was successful
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/years/REGION/VEHICLEGROUP \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
1
]
}
Find Makes
Find all Vehicle makes for a given year
URL parameters
- Name
region
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
vehicleGroup
- Type
- one of: any, 'All' Required
- Description
- Name
year
- Type
- number Required
- Description
- The year to filter results by
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean Required
- Description
- Returns true if the request was successful
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/makes/REGION/VEHICLEGROUP/YEAR \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"make": "make",
"makeId": 1
}
]
}
Find Models
Find all Vehicle models for a given year and model
URL parameters
- Name
region
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
vehicleGroup
- Type
- one of: any, 'All' Required
- Description
- Name
makeId
- Type
- number Required
- Description
- The makeId to filter results by
- Name
year
- Type
- number Required
- Description
- The year to filter results by
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean Required
- Description
- Returns true if the request was successful
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/models/REGION/VEHICLEGROUP/YEAR/MAKEID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"model": "model",
"modelId": 1
}
]
}
Find Submodels
Find all Vehicle submodels for a given year, make and model
URL parameters
- Name
region
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
vehicleGroup
- Type
- one of: any, 'All' Required
- Description
- Name
makeId
- Type
- number Required
- Description
- The makeId to filter results by
- Name
modelId
- Type
- number Required
- Description
- The modelId to filter results by
- Name
year
- Type
- number Required
- Description
- The year to filter results by
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean Required
- Description
- Returns true if the request was successful
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/submodels/REGION/VEHICLEGROUP/YEAR/MAKEID/MODELID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"submodel": "submodel",
"submodelId": 1
}
]
}
Find Vehicles by YMM
Find all Vehicles for a given year, make, model and submodel
URL parameters
- Name
region
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
vehicleGroup
- Type
- one of: any, 'All' Required
- Description
- Name
makeId
- Type
- number Required
- Description
- The makeId to filter results by
- Name
modelId
- Type
- number Required
- Description
- The modelId to filter results by
- Name
submodelId
- Type
- number
- Description
- The submodelId to filter results by
- Name
year
- Type
- number Required
- Description
- The year to filter results by
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean Required
- Description
- Returns true if the request was successful
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/REGION/VEHICLEGROUP/YEAR/MAKEID/MODELID/SUBMODELID? \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"vcdbId": 1,
"baseId": 1,
"type": null,
"year": 1,
"makeId": 1,
"make": "make",
"modelId": 1,
"model": "model",
"submodelId": 1,
"submodel": "submodel",
"vehicleTypeId": 1,
"vehicleType": "vehicleType",
"vehicleGroup": "vehicleGroup",
"drivetypeId": null,
"drivetype": null,
"transmissionId": null,
"transmissionSpeed": null,
"transmissionType": null,
"body": null,
"engine": null,
"engineId": null,
"region": "region"
}
]
}
Validate VIN
Attempt to validate the VIN value
URL parameters
- Name
vin
- Type
- string Required
- Description
- The VIN value
Produces
The response content type: application/json
200
Response
- Name
success
- Type
- boolean Required
- Description
- Returns true if the VIN is valid
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/vin/VIN \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true
}
Validate License Plate
Attempt to validate the license plate value
URL parameters
- Name
plate
- Type
- string Required
- Description
- the license plate value
- Name
region
- Type
- one of: 'US', 'CA', 'MX', 'PR'
- Description
- The region value
Produces
The response content type: application/json
200
Response
- Name
success
- Type
- boolean Required
- Description
- Returns true if the license plate is valid
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/license_plate/REGION/PLATE \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true
}
Find Vehicle Orders
Get orders for a vehicle
URL parameters
- Name
id
- Type
- string Required
- Description
- The vehicle id
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
meta
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/vehicle/ID/order \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"companyId": "companyId",
"locationId": "locationId",
"number": "number",
"vehicleId": null,
"customerId": null,
"name": null,
"coalescedName": null,
"generatedVehicleName": null,
"generatedCustomerName": null,
"archived": true,
"authorized": true,
"authorizedDate": null,
"invoiced": true,
"inspectionStatus": "inspectionStatus",
"invoicedDate": null,
"paid": true,
"totalCostCents": 1,
"remainingCostCents": null,
"workflowStatusId": null,
"workflowStatusPosition": null,
"workflowStatusDate": "workflowStatusDate",
"dueDate": null,
"fullyPaidDate": null,
"messagedDate": null,
"paymentTermId": null,
"paymentDueDate": null,
"status": "status",
"customer": {
"id": "id",
"companyId": "companyId",
"locationIds": [
"locationIds"
],
"firstName": null,
"lastName": null,
"companyName": null,
"deleted": true
},
"paymentTerm": {
"id": "id",
"name": "name",
"companyId": "companyId",
"locationId": "locationId"
},
"vehicle": {
"id": "id",
"companyId": "companyId",
"locationIds": [
"locationIds"
],
"year": null,
"make": null,
"model": null,
"submodel": null,
"vin": null,
"unit": null,
"deleted": true
}
}
],
"success": true
}
Find Tire Pressure Logs
Find the Tire Pressure Log for a given Vehicle
URL parameters
- Name
id
- Type
- string Required
- Description
- vehicle id
- Name
tirePressureLogId
- Type
- string Required
- Description
- tire pressure log id
Body parameters
Consumes
The following content type is required: application/json
- Name
orderId
- Type
- string Required
- Description
- Name
frontLeft
- Type
- number
- Description
- Name
frontRight
- Type
- number
- Description
- Name
rearLeft
- Type
- number
- Description
- Name
rearRight
- Type
- number
- Description
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
- Name
tirePressureLogs
- Type
- array Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID/tire_pressure_log/TIREPRESSURELOGID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "orderId" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"customFields": {},
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null,
"order": {
"number": 1
}
}
]
}
}
Create Tire Pressure Log
Create a new Tire Pressure Log item
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the vehicle
Body parameters
Consumes
The following content type is required: application/json
- Name
orderId
- Type
- string Required
- Description
- Name
frontLeft
- Type
- number
- Description
- Name
frontRight
- Type
- number
- Description
- Name
rearLeft
- Type
- number
- Description
- Name
rearRight
- Type
- number
- Description
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Vehicle schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- ()
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- Name
makeId
- Type
- integer Required
- Description
- vcdb make id
- Name
model
- Type
- string Required
- Description
- Name
modelId
- Type
- integer Required
- Description
- vcdb model id
- Name
submodel
- Type
- string Required
- Description
- Name
submodelId
- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine
- Type
- string Required
- Description
- Name
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
vcdbVehicleId
- Type
- string Required
- Description
- Name
ownerCount
- Type
- integer Required
- Description
- Name
orderCount
- Type
- integer Required
- Description
- Name
appointmentCount
- Type
- integer Required
- Description
- Name
tirePressureLogCount
- Type
- integer Required
- Description
- Name
mileageLogCount
- Type
- integer Required
- Description
- Name
deferredServiceCount
- Type
- integer Required
- Description
- Name
messageCount
- Type
- integer Required
- Description
- Name
computed_ymm
- Type
- string Required
- Description
- Name
customPhoto
- Type
- boolean Required
- Description
- Name
stockPhoto
- Type
- boolean Required
- Description
- Name
labels
- Type
- undefined Required
- Description
- Name
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
engineHoursLogs
- Type
- array
- Description
- Name
engines
- Type
- array
- Description
- Name
tirePressureLogs
- Type
- array Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/vehicle/ID/tire_pressure_log \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "orderId" : "value" }'