Below is the list of functions, parameters, and fields returned.

Customer

Get - Parameters: ID, VehicleID, Sort, Limit, Offset, include shopmonkey customers.

Returns:

  • Id

  • shopmonkeyId

  • firstName

  • lastName

  • emails

  • address1

  • address2

  • city

  • state

  • zip

  • creationDate

  • phones

  • Vehicles: shopmonkeyId, make, model, year, type, vin, licensePlate, submodel, engineSize, transmission, drivetrain

Post - Parameters: id, first name, last name, email, phone, address1, address2, city, state, zip, vehicleid

Returns:

  • Success or Error

Post bulk - Parameters: id, first name, last name, email, phone, address1, address2, city, state, zip, vehicleid

Returns:

  • Success or Error

Delete - Parameters: id

Returns:

  • Success or Error

Put - Parameters: id, first name, last name, email, phone, address1, address2, city, state, zip, vehicleid

Returns:

  • Success or Error

Orders

Get - Parameters: CustomerID, VehicleID, number, isAuthorized, isPaid, isInvoice, workflow, isArchived, sort, limit, offset

Returns:

  • shopmonkeyId

  • Number

  • publicId

  • mileageIn

  • mileageOut

  • Tags

  • isAuthorized

  • isInvoice

  • invoicedDate

  • isPaid

  • totalAmount

  • paidAmount

  • isArchived

  • Complaint

  • techRecommendation

  • isLaborTaxable

  • isPartShopSupplies

  • isLaborShopSupplies

  • authorizedDate

  • creationDate

  • completedDate

  • Name

  • Workflow

  • Customer: shopmonkeyId, firstName, lastName, Email, Phone

  • Vehicle: shopmonkeyId, Make, Model, Year, Type, Vin, licensePlate, submodel

Get - Parameters: number

Returns:

  • Name

  • Rate

  • Epa

  • epaValueType

  • Discount

  • discountValueType

  • Taxes

  • taxesValueType

  • shopSupplies

  • shopSuppliesValueType

  • includeInInvoice

  • shopmonkeyId

  • isLaborTaxable

  • isPartShopSupplies

  • isLaborShopSupplies

  • useGstPstHs

  • Technician

  • Labors: shopmonkeyId, Name, Hours, discountValueType, Discount, isShowHours, Position

  • Parts: shopmonkeyId, Name, Description, Number, wholesaleCost, retailCost, Quantity, discountValueType, Discount, isTaxable, Position

  • Subcontracts

  • Totals: partsSubtotal, partsSubtotalWithoutDiscount, partsTotalTaxable, partsWholesaleSubtotal, tiresSubtotal, tiresSubtotalWithoutDiscount, tiresTotalTaxable, tiresWholesaleSubtotal, laborsSubtotal, laborsTotalTaxable, laborsSubtotalWithoutDiscount, subcontractsSubtotal, subcontractsSubtotalWithoutDiscount, subcontractsTotalTaxable, subcontractsWholesaleSubtotal, feesSubtotal, feesSubtotalWithoutDiscount, epaTotal, shopSuppliesTotal, taxesTotal, gstTotal, pstTotal, hstTotal, discountTotal, discountTotalPercent, jobDiscountTotal, Subtotal, total

Users

Get - Parameters: id, role, sort, limit, offset

Returns:

  • Role

  • isActive

  • isArchived

  • isAllowedDashboard

  • isAllowedCompanySettings

  • isAllowedProfitability

  • firstName

  • lastName

  • Email

  • Id

  • shopmonkeyId

Post - Parameters: id, role, firstname, last name, email, password, phone, rate, isAllowedDashboard, isAllowedCompanySettings, isAllowedProfitability, isActive, isArchived

Returns:

  • Success or Error

Delete - Parameters: id

Returns:

  • Success or Error

Put - Parameters: id, role, firstname, last name, email, password, phone, rate, isAllowedDashboard, isAllowedCompanySettings, isAllowedProfitability, isActive, isArchived

Returns:

  • Success or Error

Post - Parameters: id

Returns:

  • Success or Error

Vehicles

Get - Parameters:id, customerid, sort, limit, offset, includeshopmonkeyvehicles

Returns:

  • Id

  • shopmonkeyId

  • Make

  • Model

  • Year

  • Type

  • Color

  • Mileage

  • Vin

  • licensePlate

  • unitNumber

  • Submodel

  • engineSize

  • Transmission

  • Drivetrain

  • creationDate

  • Owners: shopmonkeyId, firstName, lastName, Emails, Phones

Post - Parameters: id, make, model, year, type, color, milage, vin, licensePlate, unitnumber, submodel, enginesize, transmission, drivetrain, customerId

Returns:

  • Success or Error

Post bulk - Parameters: id, make, model, year, type, color, milage, vin, licensePlate, unitnumber, submodel, enginesize, transmission, drivetrain, customerId

Returns:

  • Success or Error

Delete - Parameters: id

Returns:

  • Success or Error

Post - Parameters: id, make, model, year, type, color, milage, vin, licensePlate, unitnumber, submodel, enginesize, transmission, drivetrain, customerId

Returns:

  • Success or Error

Inventory

Get - Parameters: Sort, Name, Offset, Limit

Returns:

  • Id

  • Company

  • Name

  • Quantity

  • criticalQuantity

  • creationDate

  • updateDate

  • Vendor

  • Description

  • Number

  • binLocation

  • retailCost

  • wholesaleCost

  • pricingMatrix

  • isTaxable

  • showPartNumOnQuotesInvoices

  • showPriceQtyQuotesInvoices

  • showNoteOnQuotesInvoices

  • isShort

  • isReorder

  • isDemo

  • Quickbooks

  • categoryId

Post - Parameters: none

Returns:

  • Name

  • Quantity

  • criticalQuantity

  • Vendor

  • Description

  • Number

  • binLocation

  • retailCost

  • wholesaleCost

  • pricingMatrix

  • isTaxable

  • showPartNumOnQuotesInvoices

  • showPriceQtyQuotesInvoices

  • showNoteOnQuotesInvoices

  • categoryId

Get - Parameters: id

Returns:

  • Id

  • Company

  • Name

  • Quantity

  • criticalQuantity

  • creationDate

  • updateDate

  • Vendor

  • Description

  • Number

  • binLocation

  • retailCost

  • wholesaleCost

  • pricingMatrix

  • isTaxable

  • showPartNumOnQuotesInvoices

  • showPriceQtyQuotesInvoices

  • showNoteOnQuotesInvoices

  • isShort

  • isReorder

  • isDemo

  • Quickbooks

  • categoryId

Put - Parameters: id

Returns:

  • Id

  • Company

  • Name

  • Quantity

  • criticalQuantity

  • creationDate

  • updateDate

  • Vendor

  • Description

  • Number

  • binLocation

  • retailCost

  • wholesaleCost

  • pricingMatrix

  • isTaxable

  • showPartNumOnQuotesInvoices

  • showPriceQtyQuotesInvoices

  • showNoteOnQuotesInvoices

  • categoryId

Delete - Parameters: id

Returns:

Post Bulk - Parameters: none

Returns:

  • Id

  • Company

  • Name

  • Quantity

  • criticalQuantity

  • creationDate

  • updateDate

  • Vendor

  • Description

  • Number

  • binLocation

  • retailCost

  • wholesaleCost

  • pricingMatrix

  • isTaxable

  • showPartNumOnQuotesInvoices

  • showPriceQtyQuotesInvoices

  • showNoteOnQuotesInvoices

  • isShort

  • isReorder

  • isDemo

  • Quickbooks

  • categoryId

Shopmonkey API Article

Did this answer your question?