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.

GET/v3/customer/:id/vehicle

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

Query String parameters

Name
ids
Type
array
Description
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderby
Type
string
Description
the order instructions for the result
Name
params
Type
string
Description
additional request specific params
Name
skip
Type
number
Description
the number of records to skip for a paginated result
Name
where
Type
string
Description
an object to use for filtering the results

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
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
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
object
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
object
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

GET

/v3/customer/:id/vehicle

curl https://api.shopmonkey.cloud/v3/customer/:id/vehicle \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/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
}

GET/v3/vehicle/:id

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
preferredLaborGuide
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
object 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 RequiredDeprecated
Description
Use `labels` field
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
object
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
object
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

GET

/v3/vehicle/:id

curl https://api.shopmonkey.cloud/v3/vehicle/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/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
        }
      }
    ]
  }
}

GET/v3/vehicle/export

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
object
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
object
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

GET

/v3/vehicle/export

curl https://api.shopmonkey.cloud/v3/vehicle/export \
  -H "Authorization: Bearer ${SM_TOKEN}"

POST/v3/vehicle/export

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
object
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
object
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
application/json

POST

/v3/vehicle/export

curl https://api.shopmonkey.cloud/v3/vehicle/export \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

POST/v3/vehicle/import

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
object 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
object
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
object
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
multipart/form-data

POST

/v3/vehicle/import

curl https://api.shopmonkey.cloud/v3/vehicle/import \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: multipart/form-data' \
  --data '{}'

Example Response
application/json

{}

PUT/v3/vehicle/:id

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
preferredLaborGuide
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
object
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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

PUT

/v3/vehicle/:id

curl https://api.shopmonkey.cloud/v3/vehicle/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/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
  }
}

PUT/v3/vehicle/:id/customfield

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
object
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
object
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
application/json

PUT

/v3/vehicle/:id/customfield

curl https://api.shopmonkey.cloud/v3/vehicle/:id/customfield \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id"
  }
}

POST/v3/vehicle/:id/link

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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

POST

/v3/vehicle/:id/link

curl https://api.shopmonkey.cloud/v3/vehicle/:id/link \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "vcdbId" : 0 }'

Example Response
application/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": {}
  }
}

POST/v3/vehicle

Create Vehicle

Create a new Vehicle

Query String parameters

Name
includePhoto
Type
boolean
Description
include populating stock photo synchronously

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
preferredLaborGuide
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
object
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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

POST

/v3/vehicle

curl https://api.shopmonkey.cloud/v3/vehicle \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "size" : "value" }'

Example Response
application/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": {}
  }
}

PATCH/v3/vehicle/:id/:action

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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

PATCH

/v3/vehicle/:id/:action

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 Response
application/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": {}
  }
}

GET/v3/vehicle/years/:region/:vehicleGroup

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
object
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

GET

/v3/vehicle/years/:region/:vehicleGroup

curl https://api.shopmonkey.cloud/v3/vehicle/years/:region/:vehicleGroup \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    1
  ]
}

GET/v3/vehicle/makes/:region/:vehicleGroup/:year

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
object
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

GET

/v3/vehicle/makes/:region/:vehicleGroup/:year

curl https://api.shopmonkey.cloud/v3/vehicle/makes/:region/:vehicleGroup/:year \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "make": "make",
      "makeId": 1
    }
  ]
}

GET/v3/vehicle/models/:region/:vehicleGroup/:year/:makeId

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
object
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

GET

/v3/vehicle/models/:region/:vehicleGroup/:year/:makeId

curl https://api.shopmonkey.cloud/v3/vehicle/models/:region/:vehicleGroup/:year/:makeId \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "model": "model",
      "modelId": 1
    }
  ]
}

GET/v3/vehicle/submodels/:region/:vehicleGroup/:year/:makeId/:modelId

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
object
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

GET

/v3/vehicle/submodels/:region/:vehicleGroup/:year/:makeId/:modelId

curl https://api.shopmonkey.cloud/v3/vehicle/submodels/:region/:vehicleGroup/:year/:makeId/:modelId \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "submodel": "submodel",
      "submodelId": 1
    }
  ]
}

GET/v3/vehicle/:region/:vehicleGroup/:year/:makeId/:modelId/:submodelId?

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
object
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

GET

/v3/vehicle/:region/:vehicleGroup/:year/:makeId/:modelId/:submodelId?

curl https://api.shopmonkey.cloud/v3/vehicle/:region/:vehicleGroup/:year/:makeId/:modelId/:submodelId? \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/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"
    }
  ]
}

GET/v3/vehicle/vin/:vin

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
object
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

GET

/v3/vehicle/vin/:vin

curl https://api.shopmonkey.cloud/v3/vehicle/vin/:vin \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true
}

GET/v3/vehicle/license_plate/:region/:plate

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
object
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

GET

/v3/vehicle/license_plate/:region/:plate

curl https://api.shopmonkey.cloud/v3/vehicle/license_plate/:region/:plate \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true
}

GET/v3/vehicle/:id/order

Find Vehicle Orders

Get orders for a vehicle

URL parameters

Name
id
Type
string Required
Description
The vehicle id

Query String parameters

Name
ids
Type
array
Description
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderby
Type
string
Description
the order instructions for the result
Name
params
Type
string
Description
additional request specific params
Name
skip
Type
number
Description
the number of records to skip for a paginated result
Name
where
Type
string
Description
an object to use for filtering the results

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
object
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
object
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

GET

/v3/vehicle/:id/order

curl https://api.shopmonkey.cloud/v3/vehicle/:id/order \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/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
}

PUT/v3/vehicle/:id/tire_pressure_log/:tirePressureLogId

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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

PUT

/v3/vehicle/:id/tire_pressure_log/:tirePressureLogId

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 Response
application/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
        }
      }
    ]
  }
}

POST/v3/vehicle/:id/tire_pressure_log

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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

POST

/v3/vehicle/:id/tire_pressure_log

curl https://api.shopmonkey.cloud/v3/vehicle/:id/tire_pressure_log \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "orderId" : "value" }'

Example Response
application/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
        }
      }
    ]
  }
}

DELETE/v3/vehicle/:id/tire_pressure_log/:tirePressureLogId

Delete Tire Pressure Log

Deletes the specified Tire Pressure Log item

URL parameters

Name
id
Type
string Required
Description
vehicle id
Name
tirePressureLogId
Type
string Required
Description
tire pressure log id

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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

DELETE

/v3/vehicle/:id/tire_pressure_log/:tirePressureLogId

curl https://api.shopmonkey.cloud/v3/vehicle/:id/tire_pressure_log/:tirePressureLogId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/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
        }
      }
    ]
  }
}

GET/v3/vehicle/:parentId/tire_pressure_log

Find Tire Pressure Logs

Find all Tire Pressure Logs by Vehicle id (does not include vehicle)

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

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
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
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
object
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
object
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

GET

/v3/vehicle/:parentId/tire_pressure_log

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/tire_pressure_log \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "orderId": "orderId",
      "vehicleId": "vehicleId",
      "frontLeft": null,
      "frontRight": null,
      "rearLeft": null,
      "rearRight": null,
      "order": {
        "number": "number"
      }
    }
  ],
  "success": true
}

GET/v3/vehicle/:parentId/deferred_service

Find Deferred Services

Find all Deferred Services by Vehicle

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

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
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
Name
sums
Type
object
Description
Name
total
Type
number
Description
the total number of records
Name
totalCents
Type
integer Required
Description
The total cost of all deferred services

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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

GET

/v3/vehicle/:parentId/deferred_service

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/deferred_service \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "name": "name",
      "note": "note",
      "orderId": "orderId",
      "lumpSum": true,
      "recommended": true,
      "epaPercent": 1,
      "epaCents": 1,
      "epaValueType": "epaValueType",
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "taxCents": 1,
      "taxPercent": 1,
      "taxValueType": "taxValueType",
      "gstCents": 1,
      "gstPercent": 1,
      "gstValueType": "gstValueType",
      "pstCents": 1,
      "pstPercent": 1,
      "pstValueType": "pstValueType",
      "hstCents": 1,
      "hstPercent": 1,
      "hstValueType": "hstValueType",
      "shopSuppliesApplied": true,
      "shopSuppliesCents": 1,
      "shopSuppliesPercent": 1,
      "shopSuppliesValueType": "shopSuppliesValueType",
      "authorizationStatus": "authorizationStatus",
      "calculatedPartsCents": 1,
      "calculatedTiresCents": 1,
      "calculatedLaborCents": 1,
      "calculatedSubcontractsCents": 1,
      "calculatedFeeCents": 1,
      "calculatedGSTCents": 1,
      "calculatedHSTCents": 1,
      "calculatedEpaCents": 1,
      "calculatedDiscountCents": 1,
      "calculatedDiscountPercent": 1,
      "calculatedPSTCents": 1,
      "calculatedShopSuppliesCents": 1,
      "calculatedTaxCents": 1,
      "ordinal": 1,
      "hidden": true,
      "totalCents": 1,
      "sourceServiceId": null,
      "deferredDate": null,
      "deferredReason": null,
      "excludedFromDeferred": true,
      "revived": true,
      "revivedFromId": null,
      "lineItemInventoryStatus": "lineItemInventoryStatus",
      "motorApplicationId": null,
      "pricing": "pricing",
      "fixedPriceCents": 1,
      "order": {
        "generatedVehicleName": "generatedVehicleName",
        "number": "number",
        "vehicleId": "vehicleId"
      },
      "fees": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "serviceId": "serviceId",
          "orderId": "orderId",
          "feeType": "feeType",
          "percent": 1,
          "amountCents": 1,
          "subtotalCents": null,
          "lineItemEntity": null,
          "partId": null,
          "laborId": null,
          "subcontractId": null,
          "tireId": null,
          "name": "name",
          "ordinal": 1,
          "categoryId": null,
          "sourceItemId": null,
          "inventoryFeeId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          }
        }
      ],
      "labors": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "serviceId": "serviceId",
          "orderId": "orderId",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "name": null,
          "hours": 1,
          "rateCents": 1,
          "rateId": null,
          "technicianId": null,
          "showHours": true,
          "showNote": true,
          "ordinal": 1,
          "costHours": null,
          "costRateCents": null,
          "costTotalCents": null,
          "multiplier": 1,
          "multiplierType": "multiplierType",
          "note": "note",
          "completed": true,
          "completedDate": null,
          "categoryId": null,
          "skillRequired": null,
          "skillRequiredDescription": null,
          "taxable": true,
          "taxableGST": true,
          "taxableHST": true,
          "taxablePST": true,
          "laborMatrixId": null,
          "laborMatrixDate": null,
          "applicationId": null,
          "motorApplicationId": null,
          "sourceItemId": null,
          "inventoryLaborId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "laborMatrix": {
            "id": "id",
            "name": "name"
          },
          "laborRate": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "parts": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "serviceId": "serviceId",
          "orderId": "orderId",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "quantity": 1,
          "retailCostCents": 1,
          "wholesaleCostCents": null,
          "showNote": true,
          "showPartNumber": true,
          "showCostAndQuantity": true,
          "reduceInventoryCount": true,
          "reserved": true,
          "inventoryStatus": "inventoryStatus",
          "taxable": true,
          "taxableGST": true,
          "taxableHST": true,
          "taxablePST": true,
          "ordinal": 1,
          "name": "name",
          "note": "note",
          "partNumber": null,
          "binLocation": "binLocation",
          "vendorId": null,
          "inventoryPartId": null,
          "categoryId": null,
          "pricingMatrixId": null,
          "pricingMatrixDate": null,
          "sourceItemId": null,
          "motorApplicationId": null,
          "purchaseOrderPartId": null,
          "purchaseStatus": null,
          "url": null,
          "pcDbTerminologyId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "pricingMatrix": {
            "id": "id",
            "name": "name"
          },
          "vendor": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "subcontracts": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "name": "name",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "taxable": true,
          "taxableGST": true,
          "taxableHST": true,
          "taxablePST": true,
          "costCents": 1,
          "retailCostCents": 1,
          "showNote": true,
          "note": null,
          "vendorId": null,
          "serviceId": "serviceId",
          "orderId": "orderId",
          "ordinal": 1,
          "categoryId": null,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "vendor": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "tires": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "name": "name",
          "generatedBrandName": "generatedBrandName",
          "generatedModelName": "generatedModelName",
          "calculatedName": "calculatedName",
          "note": null,
          "pricingMatrixId": null,
          "pricingMatrixDate": null,
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "quantity": 1,
          "retailCostCents": 1,
          "wholesaleCostCents": null,
          "ordinal": 1,
          "sizeFormat": "sizeFormat",
          "size": null,
          "partNumber": null,
          "binLocation": null,
          "tireModelId": null,
          "taxable": true,
          "taxableGST": true,
          "taxableHST": true,
          "taxablePST": true,
          "showPartNumber": true,
          "showPriceAndQuantity": true,
          "showNote": true,
          "serviceId": "serviceId",
          "orderId": "orderId",
          "reduceInventoryCount": true,
          "reserved": true,
          "inventoryStatus": "inventoryStatus",
          "federalExciseTaxCents": 1,
          "wasteTireFee": 1,
          "purchaseOrderTireId": null,
          "purchaseStatus": null,
          "url": null,
          "sourceItemId": null,
          "inventoryTireId": null,
          "tireIdentificationNumbers": [
            "tireIdentificationNumbers"
          ],
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "tireModel": {
            "id": "id",
            "name": "name"
          },
          "pricingMatrix": {
            "id": "id",
            "name": "name"
          }
        }
      ]
    }
  ],
  "success": true
}

GET/v3/vehicle/:parentId/owners

Find Owners

Find the owners for a Vehicle

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

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
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
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
object
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
object
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

GET

/v3/vehicle/:parentId/owners

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/owners \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationIds": [
        "locationIds"
      ],
      "customerType": "customerType",
      "firstName": null,
      "lastName": null,
      "companyName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "country": null,
      "postalCode": null,
      "dotNumber": null,
      "paymentTermId": null,
      "publicId": "publicId",
      "note": "note",
      "marketingOptIn": true,
      "preferredContactMethod": null,
      "preferredLanguage": "preferredLanguage",
      "referralSourceId": null,
      "taxExempt": true,
      "gstExempt": true,
      "hstExempt": true,
      "pstExempt": true,
      "discountPercent": 1,
      "laborRateId": null,
      "laborMatrixId": null,
      "pricingMatrixId": null,
      "fleetId": null,
      "lastTimeOrderWorked": null,
      "statementCount": 1,
      "transactionCount": 1,
      "deferredServiceCount": 1,
      "appointmentCount": 1,
      "messageCount": 1,
      "website": null,
      "normalizedFirstName": null,
      "normalizedLastName": null,
      "normalizedName": null,
      "coalescedFirstNameOrCompanyName": null,
      "vehicleCount": 1,
      "orderCount": 1,
      "finixIdentityId": null,
      "externalId": null,
      "originLocationId": null,
      "imported": true,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "phoneNumbers": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "customerId": "customerId",
          "number": "number",
          "extension": null,
          "country": null,
          "type": null,
          "userDefinedType": null,
          "carrierName": null,
          "primary": true,
          "mobileCountryCode": null,
          "mobileNetworkCode": null,
          "imported": true
        }
      ],
      "connectedLocationIds": [
        "connectedLocationIds"
      ],
      "emails": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "email": "email",
          "subscribed": true,
          "marketingOptIn": true,
          "customerId": "customerId",
          "primary": true
        }
      ],
      "labelConnections": [
        {
          "label": {
            "id": "id",
            "name": "name",
            "color": "color",
            "entity": "entity",
            "saved": true
          }
        }
      ]
    }
  ],
  "success": true
}

PUT/v3/vehicle/:id/owner

Update Owner

Update the owner of the 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
customerId
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
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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

PUT

/v3/vehicle/:id/owner

curl https://api.shopmonkey.cloud/v3/vehicle/:id/owner \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{ "customerId" : "value" }'

Example Response
application/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": {}
  }
}

DELETE/v3/vehicle/:id/owner

Delete Owner

Delete the owner of the 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
customerId
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
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
preferredLaborGuide
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
object 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
object
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
object
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
application/json

DELETE

/v3/vehicle/:id/owner

curl https://api.shopmonkey.cloud/v3/vehicle/:id/owner \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{ "customerId" : "value" }'

Example Response
application/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": {}
  }
}

GET/v3/vehicle/:parentId/order_detail

Find Vehicle Order statistics

Get order statistics for a vehicle

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
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 `data` object

Name
avgTotalCostCents
Type
number
Description
average spend for vehicle
Name
lastInvoicedDate
Type
string
Description
date of the last invoice
Name
remainingCostCents
Type
number
Description
total unpaid for vehicle
Name
totals
Type
object Required
Description

Properties for `totals` object

Name
laborCents
Type
number
Description
total labor spend on vehicle
Name
partsCents
Type
number
Description
total parts spend on vehicle
Name
subcontractsCents
Type
number
Description
total subcontract spend on vehicle
Name
tiresCents
Type
number
Description
total tire spend on vehicle
Name
totalCostCents
Type
number
Description
total spend on vehicle

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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

GET

/v3/vehicle/:parentId/order_detail

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/order_detail \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "avgTotalCostCents": 1,
    "lastInvoicedDate": "lastInvoicedDate",
    "remainingCostCents": 1,
    "totals": {
      "laborCents": 1,
      "partsCents": 1,
      "subcontractsCents": 1,
      "tiresCents": 1,
      "totalCostCents": 1
    }
  },
  "success": true
}

PUT/v3/vehicle/:id/image

Assign Custom Image

Assign a custom Vehicle image

URL parameters

Name
id
Type
string Required
Description
the id of the vehicle

Body parameters

Consumes

The following content type is required: application/json

Name
blobId
Type
string Required
Description
the id of the blob

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
blobId
Type
string Required
Description
the id of the blob
Name
vehicleId
Type
string Required
Description
the id of the vehicle

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

PUT

/v3/vehicle/:id/image

curl https://api.shopmonkey.cloud/v3/vehicle/:id/image \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{ "blobId" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "vehicleId": "vehicleId",
    "blobId": "blobId"
  }
}

DELETE/v3/vehicle/:id/image

Unassign Custom Image

Unassign a custom Vehicle image

URL parameters

Name
id
Type
string Required
Description
the id of the 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

Properties for `data` object

Name
blobId
Type
string Required
Description
the id of the blob
Name
vehicleId
Type
string Required
Description
the id of the vehicle

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

DELETE

/v3/vehicle/:id/image

curl https://api.shopmonkey.cloud/v3/vehicle/:id/image \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "vehicleId": "vehicleId",
    "blobId": "blobId"
  }
}

GET/v3/vehicle/:id/image

Find Image

Find the image for a Vehicle

URL parameters

Name
id
Type
string Required
Description
the id of the vehicle

Query String parameters

Name
authorization
Type
string
Description
optional authorization token
Name
inline
Type
boolean
Description
Name
transform
Type
string
Description
an optional transformation to apply to the blob

`302` Response

Example Request

GET

/v3/vehicle/:id/image

curl https://api.shopmonkey.cloud/v3/vehicle/:id/image \
  -H "Authorization: Bearer ${SM_TOKEN}"

GET/v3/vehicle/:parentId/mileage

Find Mileage Logs

Find the Mileage Logs for a Vehicle

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

Query String parameters

Name
ids
Type
array
Description
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderby
Type
string
Description
the order instructions for the result
Name
params
Type
string
Description
additional request specific params
Name
skip
Type
number
Description
the number of records to skip for a paginated result
Name
where
Type
string
Description
an object to use for filtering the results

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
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
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
object
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
object
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

GET

/v3/vehicle/:parentId/mileage

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/mileage \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "type": "type",
      "mileage": 1,
      "mileageDate": "mileageDate",
      "vehicleId": "vehicleId",
      "orderId": null,
      "order": {
        "number": "number"
      }
    }
  ],
  "success": true
}

POST/v3/vehicle/:id/mileage

Upsert Mileage Log

Add a manual entry Mileage Log for a Vehicle or upsert an Order in/out Mileage Log

URL parameters

Name
id
Type
string Required
Description
the id for a vehicle

Body parameters

Consumes

The following content type is required: application/json

Name
type
Type
one of: ManualEntry, OrderIn, OrderOut Required
Description
Name
mileage
Type
number Required
Description
Name
mileageDate
Type
string
Description
Name
orderId
Type
string
Description
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
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
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

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

POST

/v3/vehicle/:id/mileage

curl https://api.shopmonkey.cloud/v3/vehicle/:id/mileage \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "type" : "value", "mileage" : 0 }'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "type": "type",
      "mileage": 1,
      "mileageDate": "mileageDate",
      "vehicleId": "vehicleId",
      "orderId": null,
      "order": {
        "number": 1
      }
    }
  ]
}

PUT/v3/vehicle/:id/mileage/:mileageLogId

Update Mileage Log

Update the specified Mileage Log for a Vehicle

URL parameters

Name
id
Type
string Required
Description
the id for the vehicle
Name
mileageLogId
Type
string Required
Description
the id for the mileage log

Body parameters

Consumes

The following content type is required: application/json

Name
mileage
Type
number
Description
Name
mileageDate
Type
string
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
MileageLog 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
locationId
Type
string Required
Description
Name
type
Type
one of: ManualEntry, OrderIn, OrderOut Required
Description
Name
mileage
Type
number Required
Description
Name
mileageDate
Type
string Required
Description
Name
vehicleId
Type
string Required
Description
Name
orderId
Type
string Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

PUT

/v3/vehicle/:id/mileage/:mileageLogId

curl https://api.shopmonkey.cloud/v3/vehicle/:id/mileage/:mileageLogId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "type": "type",
    "mileage": 1,
    "mileageDate": "mileageDate",
    "vehicleId": "vehicleId",
    "orderId": null
  }
}

DELETE/v3/vehicle/:id/mileage/:mileageLogId

Delete Mileage Log

Delete the specified Mileage Log for a Vehicle

URL parameters

Name
id
Type
string Required
Description
the id for a vehicle
Name
mileageLogId
Type
string Required
Description
the id for the mileage log

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
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

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

DELETE

/v3/vehicle/:id/mileage/:mileageLogId

curl https://api.shopmonkey.cloud/v3/vehicle/:id/mileage/:mileageLogId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "type": "type",
      "mileage": 1,
      "mileageDate": "mileageDate",
      "vehicleId": "vehicleId",
      "orderId": null
    }
  ]
}

GET/v3/vehicle/:parentId/engine_log

Find Engine Hours Logs

Find Engine Hours Logs for the Vehicle

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
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 `data` object

Name
engineHoursLogs
Type
array
Description
Name
engines
Type
array
Description
Name
vehicleId
Type
string Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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

GET

/v3/vehicle/:parentId/engine_log

curl https://api.shopmonkey.cloud/v3/vehicle/:parentId/engine_log \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "engineHoursLogs": [
      {
        "engineId": "engineId",
        "orderId": "orderId",
        "orderNumber": "orderNumber",
        "updated": 1
      }
    ],
    "engines": [
      {
        "id": "id",
        "make": "make",
        "model": "model",
        "noHoursMeter": true
      }
    ],
    "vehicleId": "vehicleId"
  },
  "success": true
}

PUT/v3/vehicle/:id/engine_log

Upsert Vehicle engine hours logs

Upsert the Order in/out Engine Hours Log

URL parameters

Name
id
Type
string Required
Description
the id for a vehicle

Body parameters

Consumes

The following content type is required: application/json

Name
engineId
Type
string Required
Description
Vehicle engine ID
Name
inHours
Type
one of: any, null Required
Description
Name
orderId
Type
string Required
Description
ID of the related order
Name
orderNumber
Type
string Required
Description
User friendly order number
Name
outHours
Type
one of: any, null Required
Description
Name
updated
Type
integer Required
Description
Timestamp when this log was updated

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
engineHoursLogs
Type
array
Description
Name
engines
Type
array
Description
Name
vehicleId
Type
string Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
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
object
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
application/json

PUT

/v3/vehicle/:id/engine_log

curl https://api.shopmonkey.cloud/v3/vehicle/:id/engine_log \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{ "engineId" : "value", "inHours" : "", "orderId" : "value", "orderNumber" : "value", "outHours" : "", "updated" : 0 }'

Example Response
application/json

{
  "success": true,
  "data": {
    "engineHoursLogs": [
      {
        "engineId": "engineId",
        "orderId": "orderId",
        "orderNumber": "orderNumber",
        "updated": 1
      }
    ],
    "engines": [
      {
        "id": "id",
        "make": "make",
        "model": "model",
        "noHoursMeter": true
      }
    ],
    "vehicleId": "vehicleId"
  }
}

Vehicle

URL parameters

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

URL parameters

Produces

200 Response

Properties for data object

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Produces

200 Response

4xx Response

5xx Response

Example Request

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Body parameters

Consumes

Properties for entityType object

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestmultipart/form-data

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Query String parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `data` object

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Properties for `entityType` object

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
multipart/form-data

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response

Example Response
application/json

`200` Response

`4xx` Response