Inspection

An Inspection object describes all the information about a specific instance of an Inspection performed as part of a Customer Order.

GET/v3/inspection/:id

Find Inspection

Find one Inspection by id

URL parameters

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

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object Required
    Description
    Inspection 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
    companyId
    Type
    string Required
    Description
  • Name
    completed
    Type
    boolean Required
    Description
  • Name
    completedById
    Type
    string Required
    Description
  • Name
    completedDate
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    locationId
    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
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    items
    Type
    array Required
    Description

Properties for meta object

  • Name
    userId
    Type
    string
    Description
    the user id that made the most recent change
  • Name
    sessionId
    Type
    string
    Description
    the session id for the most recent change
  • Name
    version
    Type
    number
    Description
    a monotonically increasing number for the most recent change

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inspection/:id
curl https://api.shopmonkey.cloud/v3/inspection/: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",
    "locationId": "locationId",
    "orderId": "orderId",
    "name": "name",
    "createdById": null,
    "templateId": null,
    "completed": true,
    "completedDate": null,
    "completedById": null,
    "ordinal": 1,
    "items": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "inspectionId": "inspectionId",
        "status": null,
        "name": "name",
        "message": "message",
        "ordinal": 1,
        "inspectorUserId": null,
        "inspectionDate": null,
        "approved": true,
        "authorizationStatus": "authorizationStatus",
        "files": [
          {
            "id": "id",
            "url": "url",
            "thumbnailUrl": "thumbnailUrl",
            "fileSize": 1,
            "fileType": "fileType",
            "fileName": "fileName"
          }
        ]
      }
    ]
  }
}
GET/v3/inspection

List Inspections

Find all Inspections

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
    an array of items
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

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

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "orderId": "orderId",
      "name": "name",
      "createdById": null,
      "templateId": null,
      "completed": true,
      "completedDate": null,
      "completedById": null,
      "ordinal": 1,
      "items": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "inspectionId": "inspectionId",
          "status": null,
          "name": "name",
          "message": "message",
          "ordinal": 1,
          "inspectorUserId": null,
          "inspectionDate": null,
          "approved": true,
          "authorizationStatus": "authorizationStatus",
          "files": [
            {
              "id": "id",
              "url": "url",
              "thumbnailUrl": "thumbnailUrl",
              "fileSize": 1,
              "fileType": "fileType",
              "fileName": "fileName"
            }
          ]
        }
      ]
    }
  ]
}
PUT/v3/inspection/:id

Update Inspection

Update one Inspection by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to update

Body parameters

Consumes

The following content type is required: application/json

  • Name
    completed
    Type
    boolean
    Description
  • Name
    completedById
    Type
    string
    Description
  • Name
    completedDate
    Type
    string
    Description
  • Name
    createdById
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    orderId
    Type
    string
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    recommended
    Type
    boolean
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

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

Example Response
application/json

{
  "success": true
}
POST/v3/inspection

Create Inspection

Create an Inspection

Body parameters

Consumes

The following content type is required: application/json

  • Name
    completed
    Type
    boolean
    Description
  • Name
    completedById
    Type
    string
    Description
  • Name
    completedDate
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    recommended
    Type
    boolean
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    fromInspectionTemplateId
    Type
    string
    Description
    an inspection template id to create from
  • Name
    items
    Type
    array
    Description
  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    Inspection schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    completed
    Type
    boolean Required
    Description
  • Name
    completedById
    Type
    string Required
    Description
  • Name
    completedDate
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    items
    Type
    array Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "orderId": "orderId",
    "name": "name",
    "createdById": null,
    "templateId": null,
    "completed": true,
    "completedDate": null,
    "completedById": null,
    "ordinal": 1
  }
}
DELETE/v3/inspection/:id

Delete Inspection

Permanently delete a Inspection by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id of the record to delete

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

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

Example Response
application/json

{
  "success": true
}
GET/v3/inspection/item

Find Inspection Items

Find all Inspection Items

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    array Required
    Description
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

  • Name
    hasMore
    Type
    boolean
    Description
    if there are more records available
  • Name
    lastRefreshedAt
    Type
    string
    Description
    the last refreshed at timestamp
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number
    Description
    the total number of records

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inspection/item
curl https://api.shopmonkey.cloud/v3/inspection/item \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "inspectionId": "inspectionId",
      "status": null,
      "name": "name",
      "message": "message",
      "ordinal": 1,
      "inspectorUserId": null,
      "inspectionDate": null,
      "approved": true,
      "authorizationStatus": "authorizationStatus"
    }
  ]
}
GET/v3/inspection/item/:id

Get Inspection Item

Get an inspection item by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the item

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InspectionItem schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inspectionDate
    Type
    string Required
    Description
  • Name
    inspectionId
    Type
    string Required
    Description
  • Name
    inspectorUserId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    message
    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
    motorTaxonomyIds
    Type
    array Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    recommendedCannedServiceIds
    Type
    array Required
    Description
  • Name
    reviewedByCustomerId
    Type
    string Required
    Description
  • Name
    reviewedByUserId
    Type
    string Required
    Description
  • Name
    reviewedDate
    Type
    string Required
    Description
  • Name
    reviewStatus
    Type
    one of: DeferredByCustomer, EstimateRequested Required
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    files
    Type
    array Required
    Description
  • Name
    reviewedByCustomer
    Type
    object
    Description
    Customer schema
  • Name
    reviewedByUser
    Type
    object
    Description
    User schema
  • Name
    statusDetails
    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

Properties for reviewedByCustomer object

  • Name
    companyName
    Type
    string Required
    Description
  • Name
    firstName
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    lastName
    Type
    string Required
    Description

Properties for reviewedByUser object

  • Name
    firstName
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    lastName
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inspection/item/:id
curl https://api.shopmonkey.cloud/v3/inspection/item/: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",
    "locationId": "locationId",
    "inspectionId": "inspectionId",
    "status": null,
    "name": "name",
    "message": "message",
    "ordinal": 1,
    "inspectorUserId": null,
    "inspectionDate": null,
    "approved": true,
    "authorizationStatus": "authorizationStatus",
    "files": [
      {
        "id": "id",
        "url": "url",
        "thumbnailUrl": "thumbnailUrl",
        "fileSize": 1,
        "fileType": "fileType",
        "fileName": "fileName"
      }
    ]
  }
}
POST/v3/inspection/:id/item

Create Inspection Item

Create a new Inspection Item for the specified Inspection

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the inspection id

Body parameters

Consumes

The following content type is required: application/json

  • Name
    inspectionDate
    Type
    string
    Description
  • Name
    inspectorUserId
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    motorTaxonomyIds
    Type
    array
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    recommendedCannedServiceIds
    Type
    array
    Description
  • Name
    reviewedByCustomerId
    Type
    string
    Description
  • Name
    reviewedByUserId
    Type
    string
    Description
  • Name
    reviewedDate
    Type
    string
    Description
  • Name
    reviewStatus
    Type
    one of: DeferredByCustomer, EstimateRequested
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable
    Description
  • Name
    files
    Type
    array
    Description
    an ordered array of file ids
  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    Inspection schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    completed
    Type
    boolean Required
    Description
  • Name
    completedById
    Type
    string Required
    Description
  • Name
    completedDate
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    items
    Type
    array Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "orderId": "orderId",
    "name": "name",
    "createdById": null,
    "templateId": null,
    "completed": true,
    "completedDate": null,
    "completedById": null,
    "ordinal": 1,
    "items": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "inspectionId": "inspectionId",
        "status": null,
        "name": "name",
        "message": "message",
        "ordinal": 1,
        "inspectorUserId": null,
        "inspectionDate": null,
        "approved": true,
        "authorizationStatus": "authorizationStatus",
        "files": [
          {
            "id": "id",
            "url": "url",
            "thumbnailUrl": "thumbnailUrl",
            "fileSize": 1,
            "fileType": "fileType",
            "fileName": "fileName"
          }
        ]
      }
    ]
  }
}
PUT/v3/inspection/:id/item/:itemId

Update Inspection Item

Update Inspection Item for the specified Inspection

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the inspection
  • Name
    itemId
    Type
    string Required
    Description
    the id for the item

Body parameters

Consumes

The following content type is required: application/json

  • Name
    inspectionDate
    Type
    string
    Description
  • Name
    inspectorUserId
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    motorTaxonomyIds
    Type
    array
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    recommendedCannedServiceIds
    Type
    array
    Description
  • Name
    reviewedByCustomerId
    Type
    string
    Description
  • Name
    reviewedByUserId
    Type
    string
    Description
  • Name
    reviewedDate
    Type
    string
    Description
  • Name
    reviewStatus
    Type
    one of: DeferredByCustomer, EstimateRequested
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    Inspection schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    completed
    Type
    boolean Required
    Description
  • Name
    completedById
    Type
    string Required
    Description
  • Name
    completedDate
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    items
    Type
    array Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inspection/:id/item/:itemId
curl https://api.shopmonkey.cloud/v3/inspection/:id/item/:itemId \
  -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",
    "orderId": "orderId",
    "name": "name",
    "createdById": null,
    "templateId": null,
    "completed": true,
    "completedDate": null,
    "completedById": null,
    "ordinal": 1,
    "items": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "inspectionId": "inspectionId",
        "status": null,
        "name": "name",
        "message": "message",
        "ordinal": 1,
        "inspectorUserId": null,
        "inspectionDate": null,
        "approved": true,
        "authorizationStatus": "authorizationStatus",
        "files": [
          {
            "id": "id",
            "url": "url",
            "thumbnailUrl": "thumbnailUrl",
            "fileSize": 1,
            "fileType": "fileType",
            "fileName": "fileName"
          }
        ]
      }
    ]
  }
}
DELETE/v3/inspection/:id/item/:itemId

Delete Inspection Item

Delete the specified Inspection Item for an existing Inspection

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the inspection
  • Name
    itemId
    Type
    string Required
    Description
    the id for the item

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    Inspection schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    completed
    Type
    boolean Required
    Description
  • Name
    completedById
    Type
    string Required
    Description
  • Name
    completedDate
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    orderId
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
    flag to identify when an inspection was created from the Motor Recommended Services list
  • Name
    templateId
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    items
    Type
    array Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inspection/:id/item/:itemId
curl https://api.shopmonkey.cloud/v3/inspection/:id/item/:itemId \
  -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",
    "orderId": "orderId",
    "name": "name",
    "createdById": null,
    "templateId": null,
    "completed": true,
    "completedDate": null,
    "completedById": null,
    "ordinal": 1,
    "items": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "inspectionId": "inspectionId",
        "status": null,
        "name": "name",
        "message": "message",
        "ordinal": 1,
        "inspectorUserId": null,
        "inspectionDate": null,
        "approved": true,
        "authorizationStatus": "authorizationStatus",
        "files": [
          {
            "id": "id",
            "url": "url",
            "thumbnailUrl": "thumbnailUrl",
            "fileSize": 1,
            "fileType": "fileType",
            "fileName": "fileName"
          }
        ]
      }
    ]
  }
}
POST/v3/inspection/:id/item/:itemId/file

Add File

Add a file to an Inspection Item

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the inspection
  • Name
    itemId
    Type
    string Required
    Description
    the id for the item

Body parameters

Consumes

The following content type is required: application/json

  • Name
    fileId
    Type
    string Required
    Description
    the id for the file

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description

Properties for data object

  • Name
    fileName
    Type
    string Required
    Description
    the file name
  • Name
    fileSize
    Type
    number Required
    Description
    the file size in bytes
  • Name
    fileType
    Type
    string Required
    Description
    the content type for the file
  • Name
    id
    Type
    string Required
    Description
    the id for the file
  • Name
    thumbnailUrl
    Type
    string
    Description
    the url to the thumbnail
  • Name
    url
    Type
    string
    Description
    the url to the file

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inspection/:id/item/:itemId/file
curl https://api.shopmonkey.cloud/v3/inspection/:id/item/:itemId/file \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "fileId" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "url": "url",
    "thumbnailUrl": "thumbnailUrl",
    "fileSize": 1,
    "fileType": "fileType",
    "fileName": "fileName"
  }
}
DELETE/v3/inspection/:id/item/:itemId/file/:fileId

Delete File

Delete file from Inspection Item

URL parameters

  • Name
    fileId
    Type
    string Required
    Description
    the id for the file
  • Name
    id
    Type
    string Required
    Description
    the id for the inspection
  • Name
    itemId
    Type
    string Required
    Description
    the id for the item

Produces

The response content type: application/json

200 Response

  • Name
    httpStatusCode
    Type
    integer
    Description
    Optional http status code to use for the response
  • Name
    message
    Type
    string
    Description
    If the response was not successful this will be the error message
  • Name
    success
    Type
    boolean Required
    Description
    If the response was successful and data contains the results

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

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

Example Response
application/json

{
  "success": true
}
GET/v3/inspection/item/quicknote

List Quicknotes

Find all Inspection Item quicknotes

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    array Required
    Description
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

  • Name
    hasMore
    Type
    boolean
    Description
    if there are more records available
  • Name
    lastRefreshedAt
    Type
    string
    Description
    the last refreshed at timestamp
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number
    Description
    the total number of records

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inspection/item/quicknote
curl https://api.shopmonkey.cloud/v3/inspection/item/quicknote \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "createdById": null,
      "label": "label",
      "note": "note"
    }
  ]
}
POST/v3/inspection/item/quicknote

Create Quicknote

Create a new Inspection Item quicknote

Body parameters

Consumes

The following content type is required: application/json

  • Name
    createdById
    Type
    string
    Description
  • Name
    label
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InspectionItemQuickNote schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    label
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inspection/item/quicknote
curl https://api.shopmonkey.cloud/v3/inspection/item/quicknote \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "label" : "value", "note" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "createdById": null,
    "label": "label",
    "note": "note"
  }
}
PUT/v3/inspection/item/quicknote/:quicknoteId

Update Quicknote

Update Inspection Item quicknote

URL parameters

  • Name
    quicknoteId
    Type
    string Required
    Description
    the id of the quicknote

Body parameters

Consumes

The following content type is required: application/json

  • Name
    createdById
    Type
    string
    Description
  • Name
    label
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    locationId
    Type
    string
    Description
    the id for the location

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InspectionItemQuickNote schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    label
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inspection/item/quicknote/:quicknoteId
curl https://api.shopmonkey.cloud/v3/inspection/item/quicknote/:quicknoteId \
  -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",
    "createdById": null,
    "label": "label",
    "note": "note"
  }
}
DELETE/v3/inspection/item/quicknote/:quicknoteId

Delete Quicknote

Delete the specified Inspection Item quicknote

URL parameters

  • Name
    quicknoteId
    Type
    string Required
    Description
    the id for the quicknote

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inspection/item/quicknote/:quicknoteId
curl https://api.shopmonkey.cloud/v3/inspection/item/quicknote/:quicknoteId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}
POST/v3/inspection/item/:itemId/status_detail

Create Inspection Item Status Detail

Create a new Inspection Item Status Detail

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inspection item

Body parameters

Consumes

The following content type is required: application/json

  • Name
    label
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    selected
    Type
    boolean
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InspectionItemStatusDetail schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inspectionItemId
    Type
    string Required
    Description
  • Name
    label
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    selected
    Type
    boolean Required
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inspection/item/:itemId/status_detail
curl https://api.shopmonkey.cloud/v3/inspection/item/:itemId/status_detail \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "createdById": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "inspectionItemId": "inspectionItemId",
    "label": "label",
    "note": "note",
    "ordinal": 1,
    "status": null,
    "selected": true
  }
}
PUT/v3/inspection/item/:itemId/status_detail/:statusDetailId

Update Status Detail

Update Inspection Item Status Detail

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inspection item
  • Name
    statusDetailId
    Type
    string Required
    Description
    The id for the status detail

Body parameters

Consumes

The following content type is required: application/json

  • Name
    label
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    selected
    Type
    boolean
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InspectionItemStatusDetail schema

Properties for data object

  • Name
    companyId
    Type
    string Required
    Description
  • Name
    createdById
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    id
    Type
    string Required
    Description
  • Name
    inspectionItemId
    Type
    string Required
    Description
  • Name
    label
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    ordinal
    Type
    number Required
    Description
  • Name
    selected
    Type
    boolean Required
    Description
  • Name
    status
    Type
    one of: Green, Yellow, Red, NotApplicable Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inspection/item/:itemId/status_detail/:statusDetailId
curl https://api.shopmonkey.cloud/v3/inspection/item/:itemId/status_detail/:statusDetailId \
  -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,
    "createdById": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "inspectionItemId": "inspectionItemId",
    "label": "label",
    "note": "note",
    "ordinal": 1,
    "status": null,
    "selected": true
  }
}
DELETE/v3/inspection/item/:itemId/status_detail/:statusDetailId

Delete Status Detail

Delete the specified Inspection Item Status Detail

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inspection item
  • Name
    statusDetailId
    Type
    string Required
    Description
    The id for the status detail

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inspection/item/:itemId/status_detail/:statusDetailId
curl https://api.shopmonkey.cloud/v3/inspection/item/:itemId/status_detail/:statusDetailId \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}
PATCH/v3/inspection/item/:itemId/status_detail/reset_selection

Remove the selected flag from all Status Details

Remove the selected flag from all Status Details of an Inspection Item

URL parameters

  • Name
    itemId
    Type
    string Required
    Description
    the id for the inspection item

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PATCH
/v3/inspection/item/:itemId/status_detail/reset_selection
curl https://api.shopmonkey.cloud/v3/inspection/item/:itemId/status_detail/reset_selection \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PATCH -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}