Workflow

WIP: A summary needs to be written for Workflow

GET/v3/workflow

Find Workflows

Find all Workflows

Query String parameters

Name
limit
Type
number
Description
Name
orderby
Type
string
Description
Name
where
Type
string
Description

Produces

The response content type: application/json

`200` Response

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

Properties for `meta` object

Name
total
Type
number 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/workflow

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

Example Response
application/json

{
  "success": true,
  "data": {},
  "meta": {
    "total": 1
  }
}

GET/v3/workflow/:id

Find Column

Find a specific column for the Workflow

URL parameters

Name
id
Type
string Required
Description
the id for the object

Query String parameters

Name
limit
Type
number
Description
Name
orderby
Type
string
Description
Name
where
Type
string
Description
Name
skip
Type
number
Description

Produces

The response content type: application/json

`200` Response

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

Properties for `data` object

Name
hasMore
Type
boolean Required
Description
Name
name
Type
string Required
Description
Name
nextOrdinal
Type
number
Description
Name
orders
Type
array Required
Description
Name
position
Type
number Required
Description
Name
total
Type
number 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/workflow/:id

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

Example Response
application/json

{
  "success": true,
  "data": {
    "name": "name",
    "orders": [
      {
        "id": "id",
        "publicId": "publicId",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "number": 1,
        "vehicleId": null,
        "phoneNumberId": null,
        "emailId": null,
        "customerId": null,
        "name": null,
        "generatedName": null,
        "coalescedName": null,
        "complaint": null,
        "recommendation": null,
        "purchaseOrderNumber": null,
        "generatedVehicleName": null,
        "generatedCustomerName": null,
        "orderCreatedDate": "orderCreatedDate",
        "archived": true,
        "authorized": true,
        "authorizedDate": null,
        "invoiced": true,
        "sentToCarfax": true,
        "inspectionStatus": "inspectionStatus",
        "inspectionCount": 1,
        "invoicedDate": null,
        "paid": true,
        "appointmentDates": "2023-01-29T16:43:58.428Z",
        "assignedTechnicianIds": [
          "assignedTechnicianIds"
        ],
        "messageCount": 1,
        "shopUnreadMessageCount": 1,
        "totalCostCents": 1,
        "paidCostCents": 1,
        "remainingCostCents": null,
        "partsCents": 1,
        "tiresCents": 1,
        "laborCents": 1,
        "subcontractsCents": 1,
        "epaCents": 1,
        "discountCents": 1,
        "discountPercent": 1,
        "shopSuppliesCents": 1,
        "feesCents": 1,
        "taxCents": 1,
        "gstCents": 1,
        "pstCents": 1,
        "hstCents": 1,
        "workflowStatusId": "workflowStatusId",
        "workflowStatusPosition": 1,
        "taxConfigId": "taxConfigId",
        "dueDate": null,
        "serviceWriterId": null,
        "mileageIn": null,
        "mileageOut": null,
        "conversationId": "conversationId",
        "completedDate": null,
        "deleted": true,
        "deletedUserId": null,
        "deletedDate": null,
        "deletedReason": null,
        "readOnly": true,
        "readOnlyReason": null,
        "deferredServiceCount": 1,
        "statementId": null,
        "customFields": {},
        "profitability": {
          "parts": {
            "discountPercent": 1,
            "discountCents": 1,
            "profitCents": 1,
            "profitPercent": 1,
            "retailCents": 1,
            "wholesaleCents": 1
          },
          "labor": {
            "discountPercent": 1,
            "discountCents": 1,
            "profitCents": 1,
            "profitPercent": 1,
            "retailCents": 1,
            "wholesaleCents": 1
          },
          "subcontracts": {
            "discountPercent": 1,
            "discountCents": 1,
            "profitCents": 1,
            "profitPercent": 1,
            "retailCents": 1,
            "wholesaleCents": 1
          },
          "tires": {
            "discountPercent": 1,
            "discountCents": 1,
            "profitCents": 1,
            "profitPercent": 1,
            "retailCents": 1,
            "wholesaleCents": 1
          },
          "totalProfitPercent": 1,
          "totalProfitCents": 1,
          "totalRetailCents": 1,
          "totalWholesaleCents": 1,
          "totalDiscountCents": 1,
          "totalDiscountPercent": 1
        },
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "customer": {
          "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,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "emails": [
            {
              "id": "id",
              "createdDate": "createdDate",
              "updatedDate": null,
              "locationId": "locationId",
              "companyId": "companyId",
              "email": "email",
              "subscribed": true,
              "customerId": "customerId",
              "primary": true
            }
          ],
          "phoneNumbers": [
            {
              "id": "id",
              "createdDate": "createdDate",
              "updatedDate": null,
              "locationId": "locationId",
              "companyId": "companyId",
              "customerId": "customerId",
              "number": "number",
              "extension": null,
              "country": null,
              "type": null,
              "userDefinedType": null,
              "carrierName": null,
              "optInVerifiedDate": null,
              "optIn": true,
              "lastVerifiedDate": null,
              "primary": true,
              "mobileCountryCode": null,
              "mobileNetworkCode": null
            }
          ],
          "customFields": {}
        },
        "vehicle": {
          "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,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "tirePressureLogs": [
            {
              "id": "id",
              "createdDate": "createdDate",
              "updatedDate": null,
              "companyId": "companyId",
              "locationId": "locationId",
              "orderId": "orderId",
              "vehicleId": "vehicleId",
              "frontLeft": null,
              "frontRight": null,
              "rearLeft": null,
              "rearRight": null
            }
          ],
          "customFields": {}
        }
      }
    ],
    "total": 1,
    "hasMore": true,
    "nextOrdinal": 1
  }
}

GET/v3/workflow/list/:statusId

List all orders

Get list of all workflow orders with optional filter by workflowStatusId

URL parameters

Name
statusId
Type
string
Description
the id for the workflow status

Query String parameters

Name
limit
Type
number
Description
Name
orderby
Type
string
Description
Name
where
Type
string
Description
Name
skip
Type
number
Description

Produces

The response content type: application/json

`200` Response

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

Properties for `data` object

Name
hasMore
Type
boolean Required
Description
Name
orders
Type
array Required
Description
Name
total
Type
number 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/workflow/list/:statusId

curl https://api.shopmonkey.cloud/v3/workflow/list/:statusId \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "id",
        "publicId": "publicId",
        "number": 1,
        "vehicleId": null,
        "customerId": null,
        "coalescedName": null,
        "generatedVehicleName": null,
        "generatedCustomerName": null,
        "orderCreatedDate": "orderCreatedDate",
        "archived": true,
        "authorized": true,
        "authorizedDate": null,
        "invoiced": true,
        "inspectionStatus": "inspectionStatus",
        "invoicedDate": null,
        "paid": true,
        "appointmentDates": "2023-07-05T15:06:42.343Z",
        "assignedTechnicianIds": [
          "assignedTechnicianIds"
        ],
        "messageCount": 1,
        "shopUnreadMessageCount": 1,
        "totalCostCents": 1,
        "paidCostCents": 1,
        "remainingCostCents": null,
        "workflowStatusId": "workflowStatusId",
        "workflowStatusPosition": 1,
        "workflowStatusDate": "workflowStatusDate",
        "dueDate": null,
        "serviceWriterId": null,
        "completedDate": null,
        "fullyPaidDate": null,
        "messagedDate": null,
        "paymentTermId": "paymentTermId",
        "paymentDueDate": null,
        "labels": [
          {
            "id": "id",
            "name": "name",
            "color": "color"
          }
        ],
        "vehicleCustomPhoto": true,
        "vehicleStockPhoto": true,
        "paymentTermName": "paymentTermName"
      }
    ],
    "total": 1,
    "hasMore": true
  }
}

GET/v3/workflow/part

Find Parts

Find all Workflow Parts

Query String parameters

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

Produces

The response content type: application/json

`200` Response

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

Properties for `meta` object

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

`4xx` Response

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

`5xx` Response

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

Example Request

GET

/v3/workflow/part

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "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,
      "order": {
        "id": "id",
        "number": 1,
        "name": null,
        "generatedName": null,
        "coalescedName": null,
        "generatedVehicleName": null,
        "archived": true,
        "workflowStatusId": "workflowStatusId",
        "customer": {
          "id": "id",
          "firstName": null,
          "lastName": null
        }
      },
      "service": {
        "id": "id",
        "name": "name"
      },
      "vendor": {
        "id": "id",
        "name": "name"
      },
      "coreCharge": {
        "id": "id",
        "status": "status",
        "amountCents": 1
      },
      "labelConnections": [
        {
          "label": {
            "id": "id",
            "name": "name",
            "color": "color",
            "entity": "entity",
            "saved": true
          }
        }
      ]
    }
  ]
}

GET/v3/workflow/tire

Find Tires

Find all Workflow Tires

Query String parameters

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

Produces

The response content type: application/json

`200` Response

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

Properties for `meta` object

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

`4xx` Response

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

`5xx` Response

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

Example Request

GET

/v3/workflow/tire

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

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "locationId": "locationId",
      "companyId": "companyId",
      "name": "name",
      "generatedBrandName": "generatedBrandName",
      "generatedModelName": "generatedModelName",
      "calculatedName": "calculatedName",
      "note": null,
      "pricingMatrixId": null,
      "pricingMatrixDate": null,
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "quantity": 1,
      "retailCostCents": 1,
      "wholesaleCostCents": null,
      "ordinal": 1,
      "sizeFormat": "sizeFormat",
      "size": null,
      "partNumber": null,
      "binLocation": null,
      "tireModelId": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "showPartNumber": true,
      "showPriceAndQuantity": true,
      "showNote": true,
      "serviceId": "serviceId",
      "orderId": "orderId",
      "reduceInventoryCount": true,
      "reserved": true,
      "inventoryStatus": "inventoryStatus",
      "federalExciseTaxCents": 1,
      "wasteTireFee": 1,
      "purchaseOrderTireId": null,
      "purchaseStatus": null,
      "url": null,
      "sourceItemId": null,
      "inventoryTireId": null,
      "tireIdentificationNumbers": [
        "tireIdentificationNumbers"
      ],
      "order": {
        "id": "id",
        "number": "number",
        "name": null,
        "generatedName": null,
        "coalescedName": null,
        "generatedVehicleName": null,
        "generatedCustomerName": null,
        "archived": true,
        "workflowStatusId": null,
        "purchaseOrders": [
          {
            "id": "id",
            "number": 1,
            "status": "status",
            "provider": null
          }
        ]
      },
      "purchaseOrderTire": {
        "purchaseOrder": {
          "id": "id",
          "number": 1,
          "status": "status",
          "provider": null
        }
      },
      "service": {
        "id": "id",
        "name": "name"
      },
      "tireModel": {
        "id": "id",
        "name": "name",
        "brand": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      },
      "labelConnections": [
        {
          "label": {
            "id": "id",
            "name": "name",
            "color": "color",
            "entity": "entity",
            "saved": true
          }
        }
      ]
    }
  ],
  "success": true
}

GET/v3/workflow/core_charge

Find Core Charges

Find all Workflow Core Charges

Query String parameters

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

Produces

The response content type: application/json

`200` Response

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

Properties for `meta` object

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

`4xx` Response

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

`5xx` Response

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

Example Request

GET

/v3/workflow/core_charge

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "locationId": "locationId",
      "companyId": "companyId",
      "status": "status",
      "amountCents": 1,
      "partId": "partId",
      "part": {
        "id": "id",
        "name": "name",
        "partNumber": "partNumber"
      },
      "order": {
        "id": "id",
        "number": 1
      },
      "vendor": {
        "id": "id",
        "name": "name"
      }
    }
  ]
}

Workflow

Find Workflows

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Find Column

URL parameters

Query String parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

List all orders

URL parameters

Query String parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Find Parts

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Find Tires

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Find Core Charges

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json