Service Item
A Service Item object is an individual line item on a Service.
GET/v3/service_item
Find Service Items
Find all Service Items
URL parameters
- Name
customerId- Type
- string
- Description
- the id for the customer
- Name
vehicleId- Type
- string
- Description
- the id for the vehicle
Query String parameters
- Name
ids- Type
- array
- Description
- Name
limit- Type
- number
- Description
- the limit on the number of records to return
- Name
orderby- Type
- string
- Description
- the order instructions for the result
- Name
params- Type
- string
- Description
- additional request specific params
- Name
skip- Type
- number
- Description
- the number of records to skip for a paginated result
- Name
where- Type
- string
- Description
- an object to use for filtering the results
Produces
The response content type: application/json
200 Response
- Name
data- Type
- array Required
- Description
- Name
meta- Type
- object Required
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- Name
total- Type
- number Required
- Description
4xx Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- object
- Description
- An optional object containing relevant error data
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message- Type
- string
- Description
- the error message if not successful
- Name
success- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- object
- Description
- An optional object containing relevant error data
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message- Type
- string
- Description
- the error message if not successful
- Name
success- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
GET
/v3/service_itemcurl https://api.shopmonkey.cloud/v3/service_item \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"parts": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"reduceInventoryCount": true,
"taxable": true,
"ordinal": 1,
"name": "name",
"note": "note",
"partNumber": "partNumber",
"binLocation": "binLocation",
"vendorId": null,
"inventoryPartId": null,
"categoryId": null,
"pricingMatrixId": null,
"pricingMatrixDate": null,
"sourceItemId": null,
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": 1,
"vehicleId": null,
"phoneNumberId": null,
"emailId": null,
"customerId": null,
"name": null,
"generatedName": null,
"coalescedName": null,
"complaint": null,
"recommendation": null,
"purchaseOrderNumber": null,
"generatedVehicleName": null,
"generatedCustomerName": null,
"orderCreatedDate": "orderCreatedDate",
"archived": true,
"authorized": true,
"authorizedDate": null,
"invoiced": true,
"sentToCarfax": true,
"inspectionStatus": "inspectionStatus",
"inspectionCount": 1,
"invoicedDate": null,
"paid": true,
"appointmentDates": "2023-01-29T16:43:58.416Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true
}
},
"category": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
],
"labors": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"name": null,
"hours": 1,
"rateCents": 1,
"rateId": null,
"technicianId": null,
"showHours": true,
"showNote": true,
"ordinal": 1,
"costHours": null,
"costRateCents": null,
"costTotalCents": null,
"multiplier": 1,
"multiplierType": "multiplierType",
"note": "note",
"completed": true,
"completedDate": null,
"categoryId": null,
"skillRequired": null,
"skillRequiredDescription": null,
"taxable": true,
"laborMatrixId": null,
"laborMatrixDate": null,
"applicationId": null,
"sourceItemId": null,
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": 1,
"vehicleId": null,
"phoneNumberId": null,
"emailId": null,
"customerId": null,
"name": null,
"generatedName": null,
"coalescedName": null,
"complaint": null,
"recommendation": null,
"purchaseOrderNumber": null,
"generatedVehicleName": null,
"generatedCustomerName": null,
"orderCreatedDate": "orderCreatedDate",
"archived": true,
"authorized": true,
"authorizedDate": null,
"invoiced": true,
"sentToCarfax": true,
"inspectionStatus": "inspectionStatus",
"inspectionCount": 1,
"invoicedDate": null,
"paid": true,
"appointmentDates": "2023-01-29T16:43:58.416Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true
}
},
"category": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"technician": {
"id": "id",
"name": "name"
}
}
],
"tires": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"name": "name",
"note": null,
"pricingMatrixId": null,
"pricingMatrixDate": null,
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"ordinal": 1,
"sizeFormat": "sizeFormat",
"size": null,
"partNumber": null,
"binLocation": null,
"brandId": null,
"model": null,
"vendorId": null,
"seasonality": null,
"taxable": true,
"showPartNumber": true,
"showPriceAndQuantity": true,
"showNote": true,
"categoryId": null,
"serviceId": "serviceId",
"orderId": "orderId",
"reduceInventoryCount": true,
"federalExciseTaxCents": 1,
"wasteTireFee": 1,
"sourceItemId": null,
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": 1,
"vehicleId": null,
"phoneNumberId": null,
"emailId": null,
"customerId": null,
"name": null,
"generatedName": null,
"coalescedName": null,
"complaint": null,
"recommendation": null,
"purchaseOrderNumber": null,
"generatedVehicleName": null,
"generatedCustomerName": null,
"orderCreatedDate": "orderCreatedDate",
"archived": true,
"authorized": true,
"authorizedDate": null,
"invoiced": true,
"sentToCarfax": true,
"inspectionStatus": "inspectionStatus",
"inspectionCount": 1,
"invoicedDate": null,
"paid": true,
"appointmentDates": "2023-01-29T16:43:58.416Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true
}
},
"category": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
],
"subcontracts": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"name": "name",
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"taxable": true,
"costCents": 1,
"retailCostCents": 1,
"showNote": true,
"note": null,
"vendorId": null,
"serviceId": "serviceId",
"orderId": "orderId",
"ordinal": 1,
"categoryId": null,
"sourceItemId": null,
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": 1,
"vehicleId": null,
"phoneNumberId": null,
"emailId": null,
"customerId": null,
"name": null,
"generatedName": null,
"coalescedName": null,
"complaint": null,
"recommendation": null,
"purchaseOrderNumber": null,
"generatedVehicleName": null,
"generatedCustomerName": null,
"orderCreatedDate": "orderCreatedDate",
"archived": true,
"authorized": true,
"authorizedDate": null,
"invoiced": true,
"sentToCarfax": true,
"inspectionStatus": "inspectionStatus",
"inspectionCount": 1,
"invoicedDate": null,
"paid": true,
"appointmentDates": "2023-01-29T16:43:58.416Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true
}
},
"category": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
},
"meta": {
"total": 1,
"hasMore": true
}
}