Canned Service

A CannedService object is a reusable service that you can create to make easier when you need to add repeatable services, parts, fees, etc to a Customer Order.


GET/v3/canned_service/:id

Find Canned Service

Find one Canned Service by id

URL parameters

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

200 Response

  • Name
    data
    Type
    object Required
    Description
    CannedService schema
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

Properties for meta object

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

4xx Response

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

5xx Response

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

Example Request

GET
/v3/canned_service/:id
curl https://api.shopmonkey.cloud/v3/canned_service/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",
    "name": "name",
    "note": "note",
    "lumpSum": true,
    "recommended": true,
    "epaPercent": 1,
    "epaCents": 1,
    "epaValueType": "epaValueType",
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "taxCents": 1,
    "taxPercent": 1,
    "taxValueType": "taxValueType",
    "gstCents": 1,
    "gstPercent": 1,
    "gstValueType": "gstValueType",
    "pstCents": 1,
    "pstPercent": 1,
    "pstValueType": "pstValueType",
    "hstCents": 1,
    "hstPercent": 1,
    "hstValueType": "hstValueType",
    "shopSuppliesApplied": true,
    "shopSuppliesCents": 1,
    "shopSuppliesPercent": 1,
    "shopSuppliesValueType": "shopSuppliesValueType",
    "calculatedPartsCents": 1,
    "calculatedTiresCents": 1,
    "calculatedLaborCents": 1,
    "calculatedSubcontractsCents": 1,
    "calculatedFeeCents": 1,
    "calculatedEpaCents": 1,
    "calculatedDiscountCents": 1,
    "calculatedDiscountPercent": 1,
    "calculatedShopSuppliesCents": 1,
    "calculatedTaxCents": 1,
    "totalCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "labelConnections": [
      {
        "label": {
          "id": "id",
          "name": "name",
          "color": "color",
          "entity": "entity",
          "saved": true
        }
      }
    ],
    "labors": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "name": null,
        "hours": 1,
        "rateCents": 1,
        "rateId": null,
        "showHours": true,
        "showNote": true,
        "ordinal": 1,
        "costHours": null,
        "costRateCents": null,
        "costTotalCents": null,
        "multiplier": 1,
        "multiplierType": "multiplierType",
        "note": "note",
        "categoryId": null,
        "skillRequired": null,
        "skillRequiredDescription": null,
        "taxable": true,
        "laborMatrixId": null,
        "laborMatrixDate": null,
        "applicationId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "laborMatrix": {
          "id": "id",
          "name": "name"
        },
        "laborRate": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "parts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "showNote": true,
        "showPartNumber": true,
        "showCostAndQuantity": true,
        "reduceInventoryCount": true,
        "taxable": true,
        "ordinal": 1,
        "name": "name",
        "note": "note",
        "partNumber": "partNumber",
        "binLocation": "binLocation",
        "vendorId": null,
        "inventoryPartId": null,
        "categoryId": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "fees": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "feeType": "feeType",
        "percent": 1,
        "amountCents": 1,
        "subtotalCents": null,
        "lineItemEntity": null,
        "partId": null,
        "laborId": null,
        "subcontractId": null,
        "tireId": null,
        "name": "name",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        }
      }
    ],
    "tires": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "note": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "ordinal": 1,
        "sizeFormat": "sizeFormat",
        "size": null,
        "partNumber": null,
        "binLocation": null,
        "brandId": null,
        "model": null,
        "vendorId": null,
        "seasonality": null,
        "taxable": true,
        "showPartNumber": true,
        "showPriceAndQuantity": true,
        "showNote": true,
        "categoryId": null,
        "cannedServiceId": "cannedServiceId",
        "reduceInventoryCount": true,
        "federalExciseTaxCents": 1,
        "wasteTireFee": 1,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        },
        "brand": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "subcontracts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "taxable": true,
        "costCents": 1,
        "retailCostCents": 1,
        "showNote": true,
        "note": null,
        "vendorId": null,
        "cannedServiceId": "cannedServiceId",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ]
  }
}

GET/v3/canned_service

List Canned Services

Find all Canned Services

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
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

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

Example Request

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "name": "name",
      "note": "note",
      "lumpSum": true,
      "recommended": true,
      "epaPercent": 1,
      "epaCents": 1,
      "epaValueType": "epaValueType",
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "taxCents": 1,
      "taxPercent": 1,
      "taxValueType": "taxValueType",
      "gstCents": 1,
      "gstPercent": 1,
      "gstValueType": "gstValueType",
      "pstCents": 1,
      "pstPercent": 1,
      "pstValueType": "pstValueType",
      "hstCents": 1,
      "hstPercent": 1,
      "hstValueType": "hstValueType",
      "shopSuppliesApplied": true,
      "shopSuppliesCents": 1,
      "shopSuppliesPercent": 1,
      "shopSuppliesValueType": "shopSuppliesValueType",
      "calculatedPartsCents": 1,
      "calculatedTiresCents": 1,
      "calculatedLaborCents": 1,
      "calculatedSubcontractsCents": 1,
      "calculatedFeeCents": 1,
      "calculatedEpaCents": 1,
      "calculatedDiscountCents": 1,
      "calculatedDiscountPercent": 1,
      "calculatedShopSuppliesCents": 1,
      "calculatedTaxCents": 1,
      "totalCents": 1,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "labelConnections": [
        {
          "label": {
            "id": "id",
            "name": "name",
            "color": "color",
            "entity": "entity",
            "saved": true
          }
        }
      ],
      "labors": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "cannedServiceId": "cannedServiceId",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "name": null,
          "hours": 1,
          "rateCents": 1,
          "rateId": null,
          "showHours": true,
          "showNote": true,
          "ordinal": 1,
          "costHours": null,
          "costRateCents": null,
          "costTotalCents": null,
          "multiplier": 1,
          "multiplierType": "multiplierType",
          "note": "note",
          "categoryId": null,
          "skillRequired": null,
          "skillRequiredDescription": null,
          "taxable": true,
          "laborMatrixId": null,
          "laborMatrixDate": null,
          "applicationId": null,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "laborMatrix": {
            "id": "id",
            "name": "name"
          },
          "laborRate": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "parts": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "cannedServiceId": "cannedServiceId",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "quantity": 1,
          "retailCostCents": 1,
          "wholesaleCostCents": null,
          "showNote": true,
          "showPartNumber": true,
          "showCostAndQuantity": true,
          "reduceInventoryCount": true,
          "taxable": true,
          "ordinal": 1,
          "name": "name",
          "note": "note",
          "partNumber": "partNumber",
          "binLocation": "binLocation",
          "vendorId": null,
          "inventoryPartId": null,
          "categoryId": null,
          "pricingMatrixId": null,
          "pricingMatrixDate": null,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "pricingMatrix": {
            "id": "id",
            "name": "name"
          },
          "vendor": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "fees": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "companyId": "companyId",
          "locationId": "locationId",
          "cannedServiceId": "cannedServiceId",
          "feeType": "feeType",
          "percent": 1,
          "amountCents": 1,
          "subtotalCents": null,
          "lineItemEntity": null,
          "partId": null,
          "laborId": null,
          "subcontractId": null,
          "tireId": null,
          "name": "name",
          "ordinal": 1,
          "categoryId": null,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          }
        }
      ],
      "tires": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "name": "name",
          "note": null,
          "pricingMatrixId": null,
          "pricingMatrixDate": null,
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "quantity": 1,
          "retailCostCents": 1,
          "wholesaleCostCents": null,
          "ordinal": 1,
          "sizeFormat": "sizeFormat",
          "size": null,
          "partNumber": null,
          "binLocation": null,
          "brandId": null,
          "model": null,
          "vendorId": null,
          "seasonality": null,
          "taxable": true,
          "showPartNumber": true,
          "showPriceAndQuantity": true,
          "showNote": true,
          "categoryId": null,
          "cannedServiceId": "cannedServiceId",
          "reduceInventoryCount": true,
          "federalExciseTaxCents": 1,
          "wasteTireFee": 1,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "pricingMatrix": {
            "id": "id",
            "name": "name"
          },
          "vendor": {
            "id": "id",
            "name": "name"
          },
          "brand": {
            "id": "id",
            "name": "name"
          }
        }
      ],
      "subcontracts": [
        {
          "id": "id",
          "createdDate": "createdDate",
          "updatedDate": null,
          "locationId": "locationId",
          "companyId": "companyId",
          "name": "name",
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "taxable": true,
          "costCents": 1,
          "retailCostCents": 1,
          "showNote": true,
          "note": null,
          "vendorId": null,
          "cannedServiceId": "cannedServiceId",
          "ordinal": 1,
          "categoryId": null,
          "sourceItemId": null,
          "labelConnections": [
            {
              "label": {
                "id": "id",
                "name": "name",
                "color": "color",
                "entity": "entity",
                "saved": true
              }
            }
          ],
          "category": {
            "id": "id",
            "name": "name",
            "parent": {
              "id": "id",
              "name": "name"
            }
          },
          "vendor": {
            "id": "id",
            "name": "name"
          }
        }
      ]
    }
  ]
}

PATCH/v3/canned_service/:id/:action

Soft Delete Canned Service

Soft delete or undelete a Canned Service by id

URL parameters

  • Name
    action
    Type
    one of: 'delete', 'undelete' Required
    Description
    the action to take
  • Name
    id
    Type
    string Required
    Description
    primary key for the record

Body parameters

  • Name
    reason
    Type
    string Required
    Description
    the reason message if deleted

200 Response

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

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

4xx Response

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

5xx Response

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

Example Request
application/json

PATCH
/v3/canned_service/:id/:action
curl https://api.shopmonkey.cloud/v3/canned_service/ID/ACTION \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PATCH -H 'Content-Type: application/json' \ 
  --data '{ "reason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "lumpSum": true,
    "recommended": true,
    "epaPercent": 1,
    "epaCents": 1,
    "epaValueType": "epaValueType",
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "taxCents": 1,
    "taxPercent": 1,
    "taxValueType": "taxValueType",
    "gstCents": 1,
    "gstPercent": 1,
    "gstValueType": "gstValueType",
    "pstCents": 1,
    "pstPercent": 1,
    "pstValueType": "pstValueType",
    "hstCents": 1,
    "hstPercent": 1,
    "hstValueType": "hstValueType",
    "shopSuppliesApplied": true,
    "shopSuppliesCents": 1,
    "shopSuppliesPercent": 1,
    "shopSuppliesValueType": "shopSuppliesValueType",
    "calculatedPartsCents": 1,
    "calculatedTiresCents": 1,
    "calculatedLaborCents": 1,
    "calculatedSubcontractsCents": 1,
    "calculatedFeeCents": 1,
    "calculatedEpaCents": 1,
    "calculatedDiscountCents": 1,
    "calculatedDiscountPercent": 1,
    "calculatedShopSuppliesCents": 1,
    "calculatedTaxCents": 1,
    "totalCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "labelConnections": [
      {
        "label": {
          "id": "id",
          "name": "name",
          "color": "color",
          "entity": "entity",
          "saved": true
        }
      }
    ],
    "labors": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "name": null,
        "hours": 1,
        "rateCents": 1,
        "rateId": null,
        "showHours": true,
        "showNote": true,
        "ordinal": 1,
        "costHours": null,
        "costRateCents": null,
        "costTotalCents": null,
        "multiplier": 1,
        "multiplierType": "multiplierType",
        "note": "note",
        "categoryId": null,
        "skillRequired": null,
        "skillRequiredDescription": null,
        "taxable": true,
        "laborMatrixId": null,
        "laborMatrixDate": null,
        "applicationId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "laborMatrix": {
          "id": "id",
          "name": "name"
        },
        "laborRate": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "parts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "showNote": true,
        "showPartNumber": true,
        "showCostAndQuantity": true,
        "reduceInventoryCount": true,
        "taxable": true,
        "ordinal": 1,
        "name": "name",
        "note": "note",
        "partNumber": "partNumber",
        "binLocation": "binLocation",
        "vendorId": null,
        "inventoryPartId": null,
        "categoryId": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "fees": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "feeType": "feeType",
        "percent": 1,
        "amountCents": 1,
        "subtotalCents": null,
        "lineItemEntity": null,
        "partId": null,
        "laborId": null,
        "subcontractId": null,
        "tireId": null,
        "name": "name",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        }
      }
    ],
    "tires": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "note": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "ordinal": 1,
        "sizeFormat": "sizeFormat",
        "size": null,
        "partNumber": null,
        "binLocation": null,
        "brandId": null,
        "model": null,
        "vendorId": null,
        "seasonality": null,
        "taxable": true,
        "showPartNumber": true,
        "showPriceAndQuantity": true,
        "showNote": true,
        "categoryId": null,
        "cannedServiceId": "cannedServiceId",
        "reduceInventoryCount": true,
        "federalExciseTaxCents": 1,
        "wasteTireFee": 1,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        },
        "brand": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "subcontracts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "taxable": true,
        "costCents": 1,
        "retailCostCents": 1,
        "showNote": true,
        "note": null,
        "vendorId": null,
        "cannedServiceId": "cannedServiceId",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ]
  }
}

POST/v3/canned_service

Create Canned Service

Create a new canned service

Body parameters


200 Response

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

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

4xx Response

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

5xx Response

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

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "lumpSum": true,
    "recommended": true,
    "epaPercent": 1,
    "epaCents": 1,
    "epaValueType": "epaValueType",
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "taxCents": 1,
    "taxPercent": 1,
    "taxValueType": "taxValueType",
    "gstCents": 1,
    "gstPercent": 1,
    "gstValueType": "gstValueType",
    "pstCents": 1,
    "pstPercent": 1,
    "pstValueType": "pstValueType",
    "hstCents": 1,
    "hstPercent": 1,
    "hstValueType": "hstValueType",
    "shopSuppliesApplied": true,
    "shopSuppliesCents": 1,
    "shopSuppliesPercent": 1,
    "shopSuppliesValueType": "shopSuppliesValueType",
    "calculatedPartsCents": 1,
    "calculatedTiresCents": 1,
    "calculatedLaborCents": 1,
    "calculatedSubcontractsCents": 1,
    "calculatedFeeCents": 1,
    "calculatedEpaCents": 1,
    "calculatedDiscountCents": 1,
    "calculatedDiscountPercent": 1,
    "calculatedShopSuppliesCents": 1,
    "calculatedTaxCents": 1,
    "totalCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "labelConnections": [
      {
        "label": {
          "id": "id",
          "name": "name",
          "color": "color",
          "entity": "entity",
          "saved": true
        }
      }
    ],
    "labors": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "name": null,
        "hours": 1,
        "rateCents": 1,
        "rateId": null,
        "showHours": true,
        "showNote": true,
        "ordinal": 1,
        "costHours": null,
        "costRateCents": null,
        "costTotalCents": null,
        "multiplier": 1,
        "multiplierType": "multiplierType",
        "note": "note",
        "categoryId": null,
        "skillRequired": null,
        "skillRequiredDescription": null,
        "taxable": true,
        "laborMatrixId": null,
        "laborMatrixDate": null,
        "applicationId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "laborMatrix": {
          "id": "id",
          "name": "name"
        },
        "laborRate": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "parts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "showNote": true,
        "showPartNumber": true,
        "showCostAndQuantity": true,
        "reduceInventoryCount": true,
        "taxable": true,
        "ordinal": 1,
        "name": "name",
        "note": "note",
        "partNumber": "partNumber",
        "binLocation": "binLocation",
        "vendorId": null,
        "inventoryPartId": null,
        "categoryId": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "fees": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "feeType": "feeType",
        "percent": 1,
        "amountCents": 1,
        "subtotalCents": null,
        "lineItemEntity": null,
        "partId": null,
        "laborId": null,
        "subcontractId": null,
        "tireId": null,
        "name": "name",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        }
      }
    ],
    "tires": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "note": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "ordinal": 1,
        "sizeFormat": "sizeFormat",
        "size": null,
        "partNumber": null,
        "binLocation": null,
        "brandId": null,
        "model": null,
        "vendorId": null,
        "seasonality": null,
        "taxable": true,
        "showPartNumber": true,
        "showPriceAndQuantity": true,
        "showNote": true,
        "categoryId": null,
        "cannedServiceId": "cannedServiceId",
        "reduceInventoryCount": true,
        "federalExciseTaxCents": 1,
        "wasteTireFee": 1,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        },
        "brand": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "subcontracts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "taxable": true,
        "costCents": 1,
        "retailCostCents": 1,
        "showNote": true,
        "note": null,
        "vendorId": null,
        "cannedServiceId": "cannedServiceId",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ]
  }
}

PUT/v3/canned_service/:id

Update Canned Service

Update one canned service

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the canned service

Body parameters

  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    lumpSum
    Type
    boolean
    Description
  • Name
    recommended
    Type
    boolean
    Description
  • Name
    epaPercent
    Type
    number
    Description
  • Name
    epaCents
    Type
    integer
    Description
  • Name
    epaValueType
    Type
    string
    Description
  • Name
    discountCents
    Type
    integer
    Description
  • Name
    discountPercent
    Type
    number
    Description
  • Name
    discountValueType
    Type
    string
    Description
  • Name
    taxCents
    Type
    integer
    Description
  • Name
    taxPercent
    Type
    number
    Description
  • Name
    taxValueType
    Type
    string
    Description
  • Name
    gstCents
    Type
    integer
    Description
  • Name
    gstPercent
    Type
    number
    Description
  • Name
    gstValueType
    Type
    string
    Description
  • Name
    pstCents
    Type
    integer
    Description
  • Name
    pstPercent
    Type
    number
    Description
  • Name
    pstValueType
    Type
    string
    Description
  • Name
    hstCents
    Type
    integer
    Description
  • Name
    hstPercent
    Type
    number
    Description
  • Name
    hstValueType
    Type
    string
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean
    Description
  • Name
    shopSuppliesCents
    Type
    integer
    Description
  • Name
    shopSuppliesPercent
    Type
    number
    Description
  • Name
    shopSuppliesValueType
    Type
    string
    Description
  • Name
    bookable
    Type
    boolean
    Description
    bookable through the booking widget

200 Response

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

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

4xx Response

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

5xx Response

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

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "lumpSum": true,
    "recommended": true,
    "epaPercent": 1,
    "epaCents": 1,
    "epaValueType": "epaValueType",
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "taxCents": 1,
    "taxPercent": 1,
    "taxValueType": "taxValueType",
    "gstCents": 1,
    "gstPercent": 1,
    "gstValueType": "gstValueType",
    "pstCents": 1,
    "pstPercent": 1,
    "pstValueType": "pstValueType",
    "hstCents": 1,
    "hstPercent": 1,
    "hstValueType": "hstValueType",
    "shopSuppliesApplied": true,
    "shopSuppliesCents": 1,
    "shopSuppliesPercent": 1,
    "shopSuppliesValueType": "shopSuppliesValueType",
    "calculatedPartsCents": 1,
    "calculatedTiresCents": 1,
    "calculatedLaborCents": 1,
    "calculatedSubcontractsCents": 1,
    "calculatedFeeCents": 1,
    "calculatedEpaCents": 1,
    "calculatedDiscountCents": 1,
    "calculatedDiscountPercent": 1,
    "calculatedShopSuppliesCents": 1,
    "calculatedTaxCents": 1,
    "totalCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "labelConnections": [
      {
        "label": {
          "id": "id",
          "name": "name",
          "color": "color",
          "entity": "entity",
          "saved": true
        }
      }
    ],
    "labors": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "name": null,
        "hours": 1,
        "rateCents": 1,
        "rateId": null,
        "showHours": true,
        "showNote": true,
        "ordinal": 1,
        "costHours": null,
        "costRateCents": null,
        "costTotalCents": null,
        "multiplier": 1,
        "multiplierType": "multiplierType",
        "note": "note",
        "categoryId": null,
        "skillRequired": null,
        "skillRequiredDescription": null,
        "taxable": true,
        "laborMatrixId": null,
        "laborMatrixDate": null,
        "applicationId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "laborMatrix": {
          "id": "id",
          "name": "name"
        },
        "laborRate": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "parts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "showNote": true,
        "showPartNumber": true,
        "showCostAndQuantity": true,
        "reduceInventoryCount": true,
        "taxable": true,
        "ordinal": 1,
        "name": "name",
        "note": "note",
        "partNumber": "partNumber",
        "binLocation": "binLocation",
        "vendorId": null,
        "inventoryPartId": null,
        "categoryId": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "fees": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "feeType": "feeType",
        "percent": 1,
        "amountCents": 1,
        "subtotalCents": null,
        "lineItemEntity": null,
        "partId": null,
        "laborId": null,
        "subcontractId": null,
        "tireId": null,
        "name": "name",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        }
      }
    ],
    "tires": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "note": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "ordinal": 1,
        "sizeFormat": "sizeFormat",
        "size": null,
        "partNumber": null,
        "binLocation": null,
        "brandId": null,
        "model": null,
        "vendorId": null,
        "seasonality": null,
        "taxable": true,
        "showPartNumber": true,
        "showPriceAndQuantity": true,
        "showNote": true,
        "categoryId": null,
        "cannedServiceId": "cannedServiceId",
        "reduceInventoryCount": true,
        "federalExciseTaxCents": 1,
        "wasteTireFee": 1,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        },
        "brand": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "subcontracts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "taxable": true,
        "costCents": 1,
        "retailCostCents": 1,
        "showNote": true,
        "note": null,
        "vendorId": null,
        "cannedServiceId": "cannedServiceId",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ]
  }
}

DELETE/v3/canned_service/:id

Delete Canned Service

Permanently delete a Canned Service by id

URL parameters

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

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
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

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

Example Request
application/json

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

Example Response
application/json

{
  "success": true
}

POST/v3/canned_service/:id/part

Create Canned Service Part

Create a new canned service part item

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the canned service

Body parameters

  • Name
    discountCents
    Type
    integer
    Description
  • Name
    discountPercent
    Type
    number
    Description
  • Name
    discountValueType
    Type
    string
    Description
  • Name
    quantity
    Type
    number
    Description
  • Name
    retailCostCents
    Type
    integer
    Description
  • Name
    wholesaleCostCents
    Type
    integer
    Description
  • Name
    showNote
    Type
    boolean
    Description
  • Name
    showPartNumber
    Type
    boolean
    Description
  • Name
    showCostAndQuantity
    Type
    boolean
    Description
  • Name
    reduceInventoryCount
    Type
    boolean
    Description
  • Name
    taxable
    Type
    one of: any, any
    Description
    true if this item is taxable
  • Name
    ordinal
    Type
    number
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    partNumber
    Type
    string
    Description
  • Name
    binLocation
    Type
    string
    Description
  • Name
    vendorId
    Type
    string
    Description
  • Name
    inventoryPartId
    Type
    string
    Description
  • Name
    categoryId
    Type
    string
    Description
  • Name
    pricingMatrixId
    Type
    string
    Description
  • Name
    url
    Type
    string
    Description

200 Response

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

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

4xx Response

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

5xx Response

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

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "lumpSum": true,
    "recommended": true,
    "epaPercent": 1,
    "epaCents": 1,
    "epaValueType": "epaValueType",
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "taxCents": 1,
    "taxPercent": 1,
    "taxValueType": "taxValueType",
    "gstCents": 1,
    "gstPercent": 1,
    "gstValueType": "gstValueType",
    "pstCents": 1,
    "pstPercent": 1,
    "pstValueType": "pstValueType",
    "hstCents": 1,
    "hstPercent": 1,
    "hstValueType": "hstValueType",
    "shopSuppliesApplied": true,
    "shopSuppliesCents": 1,
    "shopSuppliesPercent": 1,
    "shopSuppliesValueType": "shopSuppliesValueType",
    "calculatedPartsCents": 1,
    "calculatedTiresCents": 1,
    "calculatedLaborCents": 1,
    "calculatedSubcontractsCents": 1,
    "calculatedFeeCents": 1,
    "calculatedEpaCents": 1,
    "calculatedDiscountCents": 1,
    "calculatedDiscountPercent": 1,
    "calculatedShopSuppliesCents": 1,
    "calculatedTaxCents": 1,
    "totalCents": 1,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "labelConnections": [
      {
        "label": {
          "id": "id",
          "name": "name",
          "color": "color",
          "entity": "entity",
          "saved": true
        }
      }
    ],
    "labors": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "name": null,
        "hours": 1,
        "rateCents": 1,
        "rateId": null,
        "showHours": true,
        "showNote": true,
        "ordinal": 1,
        "costHours": null,
        "costRateCents": null,
        "costTotalCents": null,
        "multiplier": 1,
        "multiplierType": "multiplierType",
        "note": "note",
        "categoryId": null,
        "skillRequired": null,
        "skillRequiredDescription": null,
        "taxable": true,
        "laborMatrixId": null,
        "laborMatrixDate": null,
        "applicationId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "laborMatrix": {
          "id": "id",
          "name": "name"
        },
        "laborRate": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "parts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "showNote": true,
        "showPartNumber": true,
        "showCostAndQuantity": true,
        "reduceInventoryCount": true,
        "taxable": true,
        "ordinal": 1,
        "name": "name",
        "note": "note",
        "partNumber": "partNumber",
        "binLocation": "binLocation",
        "vendorId": null,
        "inventoryPartId": null,
        "categoryId": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "fees": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "companyId": "companyId",
        "locationId": "locationId",
        "cannedServiceId": "cannedServiceId",
        "feeType": "feeType",
        "percent": 1,
        "amountCents": 1,
        "subtotalCents": null,
        "lineItemEntity": null,
        "partId": null,
        "laborId": null,
        "subcontractId": null,
        "tireId": null,
        "name": "name",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        }
      }
    ],
    "tires": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "note": null,
        "pricingMatrixId": null,
        "pricingMatrixDate": null,
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "quantity": 1,
        "retailCostCents": 1,
        "wholesaleCostCents": null,
        "ordinal": 1,
        "sizeFormat": "sizeFormat",
        "size": null,
        "partNumber": null,
        "binLocation": null,
        "brandId": null,
        "model": null,
        "vendorId": null,
        "seasonality": null,
        "taxable": true,
        "showPartNumber": true,
        "showPriceAndQuantity": true,
        "showNote": true,
        "categoryId": null,
        "cannedServiceId": "cannedServiceId",
        "reduceInventoryCount": true,
        "federalExciseTaxCents": 1,
        "wasteTireFee": 1,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "pricingMatrix": {
          "id": "id",
          "name": "name"
        },
        "vendor": {
          "id": "id",
          "name": "name"
        },
        "brand": {
          "id": "id",
          "name": "name"
        }
      }
    ],
    "subcontracts": [
      {
        "id": "id",
        "createdDate": "createdDate",
        "updatedDate": null,
        "locationId": "locationId",
        "companyId": "companyId",
        "name": "name",
        "discountCents": 1,
        "discountPercent": 1,
        "discountValueType": "discountValueType",
        "taxable": true,
        "costCents": 1,
        "retailCostCents": 1,
        "showNote": true,
        "note": null,
        "vendorId": null,
        "cannedServiceId": "cannedServiceId",
        "ordinal": 1,
        "categoryId": null,
        "sourceItemId": null,
        "labelConnections": [
          {
            "label": {
              "id": "id",
              "name": "name",
              "color": "color",
              "entity": "entity",
              "saved": true
            }
          }
        ],
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    ]
  }
}

PUT/v3/canned_service/:id/part/:itemId

Update Canned Service Part

Update one canned service part item

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the canned service
  • Name
    itemId
    Type
    string Required
    Description
    the part item id

Body parameters

  • Name
    discountCents
    Type
    integer
    Description
  • Name
    discountPercent
    Type
    number
    Description
  • Name
    discountValueType
    Type
    string
    Description
  • Name
    quantity
    Type
    number
    Description
  • Name
    retailCostCents
    Type
    integer
    Description
  • Name
    wholesaleCostCents
    Type
    integer
    Description
  • Name
    showNote
    Type
    boolean
    Description
  • Name
    showPartNumber
    Type
    boolean
    Description
  • Name
    showCostAndQuantity
    Type
    boolean
    Description
  • Name
    reduceInventoryCount
    Type
    boolean
    Description
  • Name
    taxable
    Type
    boolean
    Description
  • Name
    ordinal
    Type
    number
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    partNumber
    Type
    string
    Description
  • Name
    binLocation
    Type
    string
    Description
  • Name
    vendorId
    Type
    string
    Description
  • Name
    inventoryPartId
    Type
    string
    Description
  • Name
    categoryId
    Type
    string
    Description
  • Name
    pricingMatrixId
    Type
    string
    Description
  • Name
    url
    Type
    string
    Description

200 Response

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

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    publicId
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    lumpSum
    Type
    boolean Required
    Description
  • Name
    recommended
    Type
    boolean Required
    Description
  • Name
    epaPercent
    Type
    number Required
    Description
  • Name
    epaCents
    Type
    integer Required
    Description
  • Name
    epaValueType
    Type
    string Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    string Required
    Description
  • Name
    taxCents
    Type
    integer Required
    Description
  • Name
    taxPercent
    Type
    number Required
    Description
  • Name
    taxValueType
    Type
    string Required
    Description
  • Name
    gstCents
    Type
    integer Required
    Description
  • Name
    gstPercent
    Type
    number Required
    Description
  • Name
    gstValueType
    Type
    string Required
    Description
  • Name
    pstCents
    Type
    integer Required
    Description
  • Name
    pstPercent
    Type
    number Required
    Description
  • Name
    pstValueType
    Type
    string Required
    Description
  • Name
    hstCents
    Type
    integer Required
    Description
  • Name
    hstPercent
    Type
    number Required
    Description
  • Name
    hstValueType
    Type
    string Required
    Description
  • Name
    shopSuppliesApplied
    Type
    boolean Required
    Description
  • Name
    shopSuppliesCents
    Type
    integer Required
    Description
  • Name
    shopSuppliesPercent
    Type
    number Required
    Description
  • Name
    shopSuppliesValueType
    Type
    string Required
    Description
  • Name
    calculatedPartsCents
    Type
    integer Required
    Description
  • Name
    calculatedTiresCents
    Type
    integer Required
    Description
  • Name
    calculatedLaborCents
    Type
    integer Required
    Description
  • Name
    calculatedSubcontractsCents
    Type
    integer Required
    Description
  • Name
    calculatedFeeCents
    Type
    integer Required
    Description
  • Name
    calculatedEpaCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountCents
    Type
    integer Required
    Description
  • Name
    calculatedDiscountPercent
    Type
    number Required
    Description
  • Name
    calculatedShopSuppliesCents
    Type
    integer Required
    Description
  • Name
    calculatedTaxCents
    Type
    integer Required
    Description
  • Name
    totalCents
    Type
    integer Required
    Description
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    labels
    Type
    undefined Required
    Description
  • Name
    bookable
    Type
    boolean Required
    Description
    bookable through the booking widget
  • Name
    bookableOrdinal
    Type
    number Required
    Description
    the position in the booking widget services appear
  • Name
    labelConnections
    Type
    array Required
    Description
  • Name
    fees
    Type
    array
    Description
  • Name
    labors
    Type
    array
    Description
  • Name
    parts
    Type
    array
    Description
  • Name
    subcontracts
    Type
    array
    Description
  • Name
    tires
    Type
    array
    Description

4xx Response

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

5xx Response

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

Example Request
application/json

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

Example Response
application/json

{
  "success": true,
  "data"