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/vehicle/:id

Find Vehicle

Find one Vehicle by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to retrieve

`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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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
tirePressureLogs
Type
array Required
Description
Name
labelConnections
Type
array Required
Description
Name
mileageLogs
Type
array Required
Description
Name
originLocationId
Type
string
Description
Location id by which vehicle was created(available in HQ or when data sharing is enabled)
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
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
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

`200` Response

the data in excel format

`4xx` 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 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
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

`200` Response

the data in excel format

`4xx` 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 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
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}" \ 
  -X POST -H 'Content-Type: application/json' \ 
  --data '{}'

POST/v3/vehicle/import

Import entities

Import one or more entities

Body parameters

Name
entityType
Type
object
Description
Name
file
Type
undefined Required
Description
a multipart mime data payload in Microsoft Excel (xlsx) format

Properties for `entityType` object

Name
value
Type
string Required
Description
the entity name to import data to

`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
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
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
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}" \ 
  -X POST -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

Name
size
Type
string
Description
Name
type
Type
string
Description
Name
year
Type
integer
Description
Name
make
Type
string
Description
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
productionDate
Type
string
Description
Name
transmission
Type
string
Description
Name
transmissionId
Type
integer
Description
vcdb transmission id
Name
bodyStyle
Type
string
Description
Name
bedLength
Type
string
Description
Name
vin
Type
string
Description
Name
color
Type
string
Description
Name
unit
Type
string
Description
Name
mileageUnit
Type
string
Description
Name
odometer
Type
boolean
Description
Name
licensePlate
Type
string
Description
Name
licensePlateState
Type
string
Description
Name
licensePlateCountry
Type
string
Description
Name
note
Type
string
Description
Name
customFields
Type
object
Description
custom field values
Name
labels
Type
undefined
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
mileage
Type
number
Description
the mileage for the vehicle
Name
vcdbId
Type
number
Description
the id for the VCDB vehicle
Name
drivetrain
Type
one of: 'AWD', 'FWD', 'RWD', '4WD', 'FourWD', null
Description

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string 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
customFields
Type
object
Description
custom field values
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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

Name
customFields
Type
object
Description
custom fields as JSON object

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

Name
vcdbId
Type
number Required
Description
the id for the VCDB vehicle

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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}" \ 
  -X POST -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

Body parameters

Name
size
Type
string Required
Description
Name
type
Type
string
Description
Name
year
Type
integer
Description
Name
make
Type
string
Description
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
productionDate
Type
string
Description
Name
transmission
Type
string
Description
Name
transmissionId
Type
integer
Description
vcdb transmission id
Name
bodyStyle
Type
string
Description
Name
bedLength
Type
string
Description
Name
vin
Type
string
Description
Name
color
Type
string
Description
Name
unit
Type
string
Description
Name
mileageUnit
Type
string
Description
Name
odometer
Type
boolean
Description
Name
licensePlate
Type
string
Description
Name
licensePlateState
Type
string
Description
Name
licensePlateCountry
Type
string
Description
Name
note
Type
string
Description
Name
customFields
Type
object
Description
custom field values
Name
labels
Type
undefined
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
locationId
Type
string
Description
the id for the location
Name
mileage
Type
number
Description
the mileage for the vehicle
Name
vcdbId
Type
number
Description
the id for the VCDB vehicle

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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}" \ 
  -X POST -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

Name
reason
Type
string Required
Description
the reason message if deleted

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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
vehicleGroup
Type
string Required
Description
Name
region
Type
string Required
Description

`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
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
vehicleGroup
Type
string Required
Description
Name
region
Type
string Required
Description
Name
year
Type
number Required
Description
The year to filter results by

`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
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
vehicleGroup
Type
string Required
Description
Name
region
Type
string 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

`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
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
vehicleGroup
Type
string Required
Description
Name
region
Type
string 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

`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
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
vehicleGroup
Type
string Required
Description
Name
region
Type
string 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

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

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

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

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

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

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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
tirePressureLogs
Type
array Required
Description

`4xx` 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 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
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

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

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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
tirePressureLogs
Type
array Required
Description

`4xx` 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 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
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}" \ 
  -X POST -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

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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
tirePressureLogs
Type
array Required
Description

`4xx` 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 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
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/:id/tire_pressure_log

Find Tire Pressure Logs

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

URL parameters

Name
id
Type
string Required
Description
the id for the vehicle

`200` Response

Name
data
Type
array Required
Description
Name
meta
Type
object
Description
Name
success
Type
boolean Required
Description

Properties for `meta` object

Name
hasMore
Type
boolean Required
Description
Name
total
Type
number Required
Description

`4xx` 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 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
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/tire_pressure_log

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

Example Response
application/json

{
  "success": true,
  "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": 1
      }
    }
  ]
}

GET/v3/vehicle/:id/deferred_service

Find Deferred Services

Find all Deferred Services by Vehicle

URL parameters

Name
id
Type
string Required
Description
the id for the vehicle

`200` Response

Name
data
Type
array Required
Description
Name
meta
Type
object Required
Description
Name
success
Type
boolean Required
Description

Properties for `meta` object

Name
totalCents
Type
number Required
Description

`4xx` 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 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
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/deferred_service

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

Example Response
application/json

{
  "success": true,
  "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,
      "calculatedEpaCents": 1,
      "calculatedDiscountCents": 1,
      "calculatedDiscountPercent": 1,
      "calculatedShopSuppliesCents": 1,
      "calculatedTaxCents": 1,
      "ordinal": 1,
      "hidden": true,
      "totalCents": 1,
      "sourceServiceId": null,
      "deferredDate": null,
      "deferredReason": null,
      "excludedFromDeferred": true,
      "revived": true,
      "revivedFromId": null,
      "order": {
        "number": 1
      },
      "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,
          "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,
          "laborMatrixId": null,
          "laborMatrixDate": null,
          "applicationId": 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"
            }
          },
          "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,
          "taxable": true,
          "ordinal": 1,
          "name": "name",
          "note": "note",
          "partNumber": "partNumber",
          "binLocation": "binLocation",
          "vendorId": null,
          "inventoryPartId": null,
          "categoryId": null,
          "pricingMatrixId": null,
          "pricingMatrixDate": 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"
            }
          },
          "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,
          "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",
          "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,
          "brandId": null,
          "model": null,
          "vendorId": null,
          "seasonality": null,
          "taxable": true,
          "showPartNumber": true,
          "showPriceAndQuantity": true,
          "showNote": true,
          "categoryId": null,
          "serviceId": "serviceId",
          "orderId": "orderId",
          "reduceInventoryCount": true,
          "federalExciseTaxCents": 1,
          "wasteTireFee": 1,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "brand": {
            "id": "id",
            "name": "name"
          },
          "pricingMatrix": {
            "id": "id",
            "name": "name"
          },
          "vendor": {
            "id": "id",
            "name": "name"
          }
        }
      ]
    }
  ],
  "meta": {
    "totalCents": 1
  }
}

GET/v3/vehicle/:id/owners

Find Owners

Find the owners for a Vehicle

URL parameters

Name
id
Type
string Required
Description
the id for the vehicle

`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
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
array Required
Description

`4xx` 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 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
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/owners

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "customerType": "customerType",
      "firstName": null,
      "lastName": null,
      "companyName": null,
      "address1": null,
      "address2": null,
      "city": null,
      "state": null,
      "country": null,
      "postalCode": null,
      "dotNumber": null,
      "paymentTermId": "paymentTermId",
      "note": "note",
      "marketingOptIn": true,
      "preferredContactMethod": null,
      "referralSourceId": null,
      "taxExempt": true,
      "discountPercent": 1,
      "laborRateId": null,
      "laborMatrixId": null,
      "pricingMatrixId": null,
      "fleetId": null,
      "lastTimeOrderWorked": null,
      "statementCount": 1,
      "transactionCount": 1,
      "deferredServiceCount": 1,
      "appointmentCount": 1,
      "messageCount": 1
    }
  ]
}

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

Name
customerId
Type
string Required
Description
the customer id

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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

Name
customerId
Type
string Required
Description
the customer id

`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
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
size
Type
string Required
Description
Name
type
Type
string Required
Description
Name
year
Type
integer Required
Description
Name
make
Type
string Required
Description
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
productionDate
Type
string Required
Description
Name
transmission
Type
string Required
Description
Name
transmissionId
Type
integer Required
Description
vcdb transmission id
Name
drivetrain
Type
string Required
Description
Name
bodyStyle
Type
string Required
Description
Name
bedLength
Type
string Required
Description
Name
vin
Type
string Required
Description
Name
color
Type
string Required
Description
Name
unit
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageUnit
Type
string Required
Description
Name
odometer
Type
boolean Required
Description
Name
licensePlate
Type
string Required
Description
Name
licensePlateState
Type
string Required
Description
Name
licensePlateCountry
Type
string Required
Description
Name
note
Type
string Required
Description
Name
vcdbVehicleId
Type
string Required
Description
Name
ownerCount
Type
integer Required
Description
Name
orderCount
Type
integer Required
Description
Name
appointmentCount
Type
integer Required
Description
Name
tirePressureLogCount
Type
integer Required
Description
Name
mileageLogCount
Type
integer Required
Description
Name
deferredServiceCount
Type
integer Required
Description
Name
messageCount
Type
integer Required
Description
Name
computed_ymm
Type
string Required
Description
Name
customPhoto
Type
boolean Required
Description
Name
stockPhoto
Type
boolean Required
Description
Name
labels
Type
undefined Required
Description
Name
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

`4xx` 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 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
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": {}
  }
}

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

Name
blobId
Type
string Required
Description
the id of the blob

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

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

`302` Response

Example Request

GET

/v3/vehicle/:id/image

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

POST/v3/vehicle/search

Find VCDB Vehicle

Find a VCDB vehicle for a vin/licenseplate/ymm

Body parameters

Name
region
Type
string
Description
Name
searchField
Type
string
Description
Name
stateprov
Type
string Required
Description
the state or province to use for filtering the results
Name
term
Type
string Required
Description
the search term

`200` Response

Name
data
Type
array Required
Description
Name
success
Type
boolean Required
Description

`4xx` 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 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
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/search

curl https://api.shopmonkey.cloud/v3/vehicle/search \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X POST -H 'Content-Type: application/json' \ 
  --data '{ "stateprov" : "value", "term" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "vehicleId": "vehicleId",
      "vcdbId": 1,
      "vcdbVehicleId": "vcdbVehicleId",
      "size": "size",
      "year": 1,
      "make": "make",
      "makeId": 1,
      "model": "model",
      "modelId": 1,
      "submodel": "submodel",
      "submodelId": 1,
      "type": "type",
      "engine": "engine",
      "drivetrain": "drivetrain",
      "transmission": "transmission",
      "color": "color",
      "vin": "vin",
      "licensePlate": "licensePlate",
      "owners": [
        {
          "firstName": null,
          "lastName": null
        }
      ],
      "productionDate": "productionDate",
      "unit": "unit",
      "mileage": 1,
      "odometer": true,
      "licensePlateState": "licensePlateState",
      "licensePlateCountry": "licensePlateCountry",
      "note": "note"
    }
  ],
  "searched": [
    "searched"
  ]
}

GET/v3/vehicle/:id/mileage

Find Mileage Logs

Find the Mileage Logs for a Vehicle

URL parameters

Name
id
Type
string Required
Description
the id for the vehicle

`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
meta
Type
object
Description
Name
success
Type
boolean Required
Description

Properties for `meta` object

Name
hasMore
Type
boolean Required
Description
if there are more records available
Name
sums
Type
object
Description
Name
total
Type
number Required
Description
the total number of records

`4xx` 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 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
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/mileage

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

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

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

Name
locationId
Type
string
Description
Name
type
Type
string Required
Description
Name
mileage
Type
number Required
Description
Name
mileageDate
Type
string
Description
Name
orderId
Type
string
Description

`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
success
Type
boolean Required
Description

`4xx` 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 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
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}" \ 
  -X POST -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

Name
mileage
Type
number
Description
Name
mileageDate
Type
string
Description

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

`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
success
Type
boolean Required
Description

`4xx` 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 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
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
    }
  ]
}

Vehicle

URL parameters

200 Response

Properties for data object

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

200 Response

4xx Response

5xx Response

Example Request

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Body parameters

Properties for entityType object

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestmultipart/form-data

Example Responseapplication/json

URL parameters

Body parameters

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Body parameters

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

200 Response

4xx Response

Example Request

Example Responseapplication/json

URL parameters

200 Response

4xx Response

Example Request

Example Responseapplication/json

URL parameters

200 Response

4xx Response

Example Request

Example Responseapplication/json

URL parameters

`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

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