Order
An Order object is a specific instance of the order you perform on behalf of your Customers. An Order can have various states depending on the lifecycle stage of how you process the work.
GET/v3/customer/:id/order
Find Customer Orders
Get orders for a customer
URL parameters
- Name
id- Type
- string Required
- Description
- The customer id
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/customer/:id/ordercurl https://api.shopmonkey.cloud/v3/customer/ID/order \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"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-08-24T20:40:07.434Z",
"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,
"transactionalFeeTotalCents": 1,
"transactionalFeeSubtotalCents": 1,
"requestedDepositCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"workflowStatusDate": "workflowStatusDate",
"taxConfigId": "taxConfigId",
"transactionFeeConfigId": null,
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": null,
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"fullyPaidDate": null,
"messagedDate": null,
"paymentTermId": "paymentTermId",
"paymentDueDate": null,
"allowCollectPayment": true,
"allowCustomerAuthorization": true,
"allowCustomerESign": true,
"allowCustomerViewMessages": true,
"allowCustomerViewAuthorizations": true,
"allowCustomerViewActivity": true,
"customFields": {},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"workflowStatus": {
"id": "id",
"name": null
},
"paymentTerm": {
"id": "id",
"name": "name"
}
}
]
}
GET/v3/order/:orderId/service
Get Services
Get Services for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
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
- array Required
- 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
GET
/v3/order/:orderId/servicecurl https://api.shopmonkey.cloud/v3/order/ORDERID/service \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"inventoryTireId": null,
"tireIdentificationNumbers": [
"tireIdentificationNumbers"
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
PUT/v3/order/:orderId/service/:id
Update Service
Update a Service for an Order
URL parameters
- Name
id- Type
- string Required
- Description
- the id for service
- Name
orderId- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
locationId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
note- Type
- string
- Description
- Name
orderId- 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
- if SS max cap percentage should apply, always true if taxConfig SS setting is NoCap
- Name
shopSuppliesCents- Type
- integer
- Description
- Name
shopSuppliesPercent- Type
- number
- Description
- Name
shopSuppliesValueType- Type
- string
- Description
- Name
authorizationStatus- Type
- string
- Description
- Name
ordinal- Type
- number
- Description
- Name
hidden- Type
- boolean
- Description
- Name
totalCents- Type
- integer
- Description
- Name
sourceServiceId- Type
- string
- Description
- Name
excludedFromDeferred- Type
- boolean
- Description
- service that has been removed from the deferred list
- Name
revivedFromId- Type
- string
- Description
- service that was deferred and then re-added, used for chain of deferment tracing
- Name
lineItemInventoryStatus- Type
- string
- Description
- Name
motorApplicationId- Type
- integer
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.386Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service
Add Service
Add a Service to an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
Body parameters
Array with the following properties:
- Name
fromCannedServiceId- Type
- string Required
- Description
- the id for the service
- Name
fromDeferredServiceId- Type
- string Required
- Description
- the id for the service
- 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
- if SS max cap percentage should apply, always true if taxConfig SS setting is NoCap
- Name
shopSuppliesCents- Type
- integer
- Description
- Name
shopSuppliesPercent- Type
- number
- Description
- Name
authorizationStatus- Type
- string
- Description
- Name
ordinal- Type
- number
- Description
- Name
hidden- Type
- boolean
- Description
- Name
totalCents- Type
- integer
- Description
- Name
sourceServiceId- Type
- string
- Description
- Name
excludedFromDeferred- Type
- boolean
- Description
- service that has been removed from the deferred list
- Name
revivedFromId- Type
- string
- Description
- service that was deferred and then re-added, used for chain of deferment tracing
- Name
lineItemInventoryStatus- Type
- string
- Description
- Name
motorApplicationId- Type
- integer
- 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
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/servicecurl https://api.shopmonkey.cloud/v3/order/ORDERID/service \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.386Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:id
Delete Service
Delete a Service from an Order
URL parameters
- Name
id- Type
- string Required
- Description
- the id for service
- Name
orderId- Type
- string Required
- Description
- the id for the order
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.387Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/part_bulk
Update Bulk Parts
Update Bulk Parts for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
Body parameters
Array of objects with the following properties:
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/part_bulkcurl https://api.shopmonkey.cloud/v3/order/ORDERID/part_bulk \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": "number",
"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-12-19T16:28:46.091Z",
"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,
"transactionalFeeTotalCents": 1,
"transactionalFeeSubtotalCents": 1,
"requestedDepositCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"workflowStatusDate": "workflowStatusDate",
"taxConfigId": "taxConfigId",
"transactionFeeConfigId": null,
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": null,
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"fullyPaidDate": null,
"messagedDate": null,
"paymentTermId": "paymentTermId",
"paymentDueDate": null,
"allowCollectPayment": true,
"allowCustomerAuthorization": true,
"allowCustomerViewMessages": true,
"allowCustomerViewAuthorizations": true,
"allowCustomerViewActivity": true,
"requireESignatureOnAuthorization": true,
"requireESignatureOnInvoice": true,
"updatedSinceSignedInvoice": true,
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"duration": null,
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId",
"confirmationSubject": null,
"confirmationText": null,
"reminderSubject": null,
"reminderText": null,
"confirmationStatus": "confirmationStatus"
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"customFields": {},
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": null,
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"website": null,
"normalizedFirstName": null,
"normalizedLastName": null,
"normalizedName": null,
"vehicleCount": 1,
"orderCount": 1,
"finixIdentityId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customFields": {},
"emails": [
{
"id": "id",
"email": "email",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"number": "number",
"extension": null,
"type": null,
"userDefinedType": null,
"primary": true
}
]
},
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"paymentTerm": {
"id": "id",
"name": "name"
},
"profitability": {
"labor": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"parts": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalDiscountCents": 1,
"totalDiscountPercent": 1,
"totalProfitCents": 1,
"totalProfitPercent": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"lineItemInventoryStatus": "lineItemInventoryStatus",
"motorApplicationId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"motorApplicationId": 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",
"serviceId": "serviceId",
"orderId": "orderId",
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"reduceInventoryCount": true,
"reserved": true,
"inventoryStatus": "inventoryStatus",
"taxable": true,
"ordinal": 1,
"name": "name",
"note": "note",
"partNumber": null,
"binLocation": "binLocation",
"vendorId": null,
"inventoryPartId": null,
"categoryId": null,
"pricingMatrixId": null,
"pricingMatrixDate": null,
"sourceItemId": null,
"motorApplicationId": null,
"purchaseOrderPartId": null,
"purchaseStatus": 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"
},
"inventoryPart": {
"availableQuantity": 1,
"id": "id",
"minCriticalQuantity": 1,
"name": "name",
"quantity": 1,
"retailCostCents": 1
}
}
],
"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,
"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"
}
}
],
"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,
"tireModelId": null,
"taxable": true,
"showPartNumber": true,
"showPriceAndQuantity": true,
"showNote": true,
"serviceId": "serviceId",
"orderId": "orderId",
"reduceInventoryCount": true,
"reserved": true,
"inventoryStatus": "inventoryStatus",
"federalExciseTaxCents": 1,
"wasteTireFee": 1,
"purchaseOrderTireId": null,
"purchaseStatus": null,
"sourceItemId": null,
"inventoryTireId": null,
"tireIdentificationNumbers": [
"tireIdentificationNumbers"
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"pricingMatrix": {
"id": "id",
"name": "name"
},
"inventoryTire": {
"availableQuantity": 1,
"id": "id",
"minCriticalQuantity": 1,
"name": "name",
"quantity": 1,
"retailCostCents": 1
}
}
]
}
],
"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,
"bodyStyle": null,
"bedLength": 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,
"computed_ymm": null,
"customPhoto": true,
"stockPhoto": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customFields": {},
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
]
},
"workflowStatus": {
"id": "id",
"name": null
}
}
}
}
PUT/v3/order/:orderId/bulk_reserve
Reserve multiple parts and tires
Reserve multiple parts and tires on an order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
parts- Type
- array
- Description
- Name
tires- Type
- array
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/bulk_reservecurl https://api.shopmonkey.cloud/v3/order/ORDERID/bulk_reserve \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"order": {
"id": "id",
"publicId": "publicId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"number": "number",
"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-12-19T16:28:46.091Z",
"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,
"transactionalFeeTotalCents": 1,
"transactionalFeeSubtotalCents": 1,
"requestedDepositCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"workflowStatusDate": "workflowStatusDate",
"taxConfigId": "taxConfigId",
"transactionFeeConfigId": null,
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": null,
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"fullyPaidDate": null,
"messagedDate": null,
"paymentTermId": "paymentTermId",
"paymentDueDate": null,
"allowCollectPayment": true,
"allowCustomerAuthorization": true,
"allowCustomerViewMessages": true,
"allowCustomerViewAuthorizations": true,
"allowCustomerViewActivity": true,
"requireESignatureOnAuthorization": true,
"requireESignatureOnInvoice": true,
"updatedSinceSignedInvoice": true,
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"duration": null,
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId",
"confirmationSubject": null,
"confirmationText": null,
"reminderSubject": null,
"reminderText": null,
"confirmationStatus": "confirmationStatus"
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"customFields": {},
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": null,
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"website": null,
"normalizedFirstName": null,
"normalizedLastName": null,
"normalizedName": null,
"vehicleCount": 1,
"orderCount": 1,
"finixIdentityId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customFields": {},
"emails": [
{
"id": "id",
"email": "email",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"number": "number",
"extension": null,
"type": null,
"userDefinedType": null,
"primary": true
}
]
},
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"paymentTerm": {
"id": "id",
"name": "name"
},
"profitability": {
"labor": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"parts": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountCents": 1,
"discountPercent": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalDiscountCents": 1,
"totalDiscountPercent": 1,
"totalProfitCents": 1,
"totalProfitPercent": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"lineItemInventoryStatus": "lineItemInventoryStatus",
"motorApplicationId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"motorApplicationId": 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",
"serviceId": "serviceId",
"orderId": "orderId",
"discountCents": 1,
"discountPercent": 1,
"discountValueType": "discountValueType",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"reduceInventoryCount": true,
"reserved": true,
"inventoryStatus": "inventoryStatus",
"taxable": true,
"ordinal": 1,
"name": "name",
"note": "note",
"partNumber": null,
"binLocation": "binLocation",
"vendorId": null,
"inventoryPartId": null,
"categoryId": null,
"pricingMatrixId": null,
"pricingMatrixDate": null,
"sourceItemId": null,
"motorApplicationId": null,
"purchaseOrderPartId": null,
"purchaseStatus": 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"
},
"inventoryPart": {
"availableQuantity": 1,
"id": "id",
"minCriticalQuantity": 1,
"name": "name",
"quantity": 1,
"retailCostCents": 1
}
}
],
"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,
"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"
}
}
],
"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,
"tireModelId": null,
"taxable": true,
"showPartNumber": true,
"showPriceAndQuantity": true,
"showNote": true,
"serviceId": "serviceId",
"orderId": "orderId",
"reduceInventoryCount": true,
"reserved": true,
"inventoryStatus": "inventoryStatus",
"federalExciseTaxCents": 1,
"wasteTireFee": 1,
"purchaseOrderTireId": null,
"purchaseStatus": null,
"sourceItemId": null,
"inventoryTireId": null,
"tireIdentificationNumbers": [
"tireIdentificationNumbers"
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"pricingMatrix": {
"id": "id",
"name": "name"
},
"inventoryTire": {
"availableQuantity": 1,
"id": "id",
"minCriticalQuantity": 1,
"name": "name",
"quantity": 1,
"retailCostCents": 1
}
}
]
}
],
"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,
"bodyStyle": null,
"bedLength": 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,
"computed_ymm": null,
"customPhoto": true,
"stockPhoto": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customFields": {},
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
]
},
"workflowStatus": {
"id": "id",
"name": null
}
}
}
}
PUT/v3/order/:orderId/service/:serviceId/part/:id
Update Order Line Item
Update an Order Line Item for part
URL parameters
- Name
id- Type
- string Required
- Description
- the id for part
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
serviceId- Type
- string
- Description
- Name
orderId- Type
- string
- Description
- 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
reserved- Type
- boolean
- Description
- Name
inventoryStatus- Type
- string
- Description
- Name
taxable- Type
- boolean
- Description
- US specific
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- 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
sourceItemId- Type
- string
- Description
- Name
motorApplicationId- Type
- integer
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:serviceId/part/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/part/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.387Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service/:serviceId/part
Add Part to Service
Add a Part to a Service for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- 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
reserved- Type
- boolean
- Description
- Name
inventoryStatus- Type
- string
- Description
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- 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
sourceItemId- Type
- string
- Description
- Name
motorApplicationId- Type
- integer
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/service/:serviceId/partcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/part \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.388Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:serviceId/part/:id
Delete Order Line Item
Delete an Order Line Item for part
URL parameters
- Name
id- Type
- string Required
- Description
- the id for part
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:serviceId/part/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/part/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.389Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/labor_bulk
Update Bulk Labor
Update Bulk Labor Items for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
data- Type
- object Required
- Description
- update to be applied
- Name
ids- Type
- array Required
- Description
- ids of labors to update
Properties for data object
- Name
technicianId- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/labor_bulkcurl https://api.shopmonkey.cloud/v3/order/ORDERID/labor_bulk \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "data" : {}, "ids" : [] }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.389Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/service/:serviceId/labor/:id
Update Order Line Item
Update an Order Line Item for labor
URL parameters
- Name
id- Type
- string Required
- Description
- the id for labor
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
serviceId- Type
- string
- Description
- Name
orderId- Type
- string
- Description
- Name
discountCents- Type
- integer
- Description
- Name
discountPercent- Type
- number
- Description
- Name
discountValueType- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
hours- Type
- number
- Description
- Name
rateCents- Type
- integer
- Description
- Name
rateId- Type
- string
- Description
- Name
technicianId- Type
- string
- Description
- Name
showHours- Type
- boolean
- Description
- Name
showNote- Type
- boolean
- Description
- Name
ordinal- Type
- number
- Description
- Name
costHours- Type
- number
- Description
- Name
costRateCents- Type
- integer
- Description
- Name
costTotalCents- Type
- integer
- Description
- Name
multiplier- Type
- number
- Description
- Name
multiplierType- Type
- string
- Description
- Name
note- Type
- string
- Description
- Name
completed- Type
- boolean
- Description
- Name
completedDate- Type
- string
- Description
- Name
categoryId- Type
- string
- Description
- Name
skillRequired- Type
- string
- Description
- Name
skillRequiredDescription- Type
- string
- Description
- Name
taxable- Type
- boolean
- Description
- US specific
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
laborMatrixId- Type
- string
- Description
- Name
applicationId- Type
- integer
- Description
- This is deprecated, use motorApplicationId
- Name
motorApplicationId- Type
- integer
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:serviceId/labor/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/labor/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.389Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service/:serviceId/labor
Add Labor to Service
Add a Labor to a Service for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
discountCents- Type
- integer
- Description
- Name
discountPercent- Type
- number
- Description
- Name
discountValueType- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
hours- Type
- number
- Description
- Name
technicianId- Type
- string
- Description
- Name
showHours- Type
- boolean
- Description
- Name
showNote- Type
- boolean
- Description
- Name
ordinal- Type
- number
- Description
- Name
costHours- Type
- number
- Description
- Name
costRateCents- Type
- integer
- Description
- Name
costTotalCents- Type
- integer
- Description
- Name
multiplier- Type
- number
- Description
- Name
multiplierType- Type
- string
- Description
- Name
note- Type
- string
- Description
- Name
completed- Type
- boolean
- Description
- Name
completedDate- Type
- string
- Description
- Name
categoryId- Type
- string
- Description
- Name
skillRequired- Type
- string
- Description
- Name
skillRequiredDescription- Type
- string
- Description
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
laborMatrixId- Type
- string
- Description
- Name
applicationId- Type
- integer
- Description
- This is deprecated, use motorApplicationId
- Name
motorApplicationId- Type
- integer
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/service/:serviceId/laborcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/labor \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.390Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:serviceId/labor/:id
Delete Order Line Item
Delete an Order Line Item for labor
URL parameters
- Name
id- Type
- string Required
- Description
- the id for labor
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:serviceId/labor/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/labor/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.390Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/service/:serviceId/fee/:id
Update Order Line Item
Update an Order Line Item for fee
URL parameters
- Name
id- Type
- string Required
- Description
- the id for fee
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
serviceId- Type
- string
- Description
- Name
orderId- Type
- string
- Description
- Name
feeType- Type
- string
- Description
- Name
percent- Type
- number
- Description
- Name
amountCents- Type
- integer
- Description
- Name
subtotalCents- Type
- integer
- Description
- Name
lineItemEntity- Type
- string
- Description
- Name
partId- Type
- string
- Description
- Name
laborId- Type
- string
- Description
- Name
subcontractId- Type
- string
- Description
- Name
tireId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
ordinal- Type
- number
- Description
- Name
categoryId- Type
- string
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:serviceId/fee/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/fee/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.391Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service/:serviceId/fee
Add Fee to Service
Add a Fee to a Service for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
feeType- Type
- string
- Description
- Name
percent- Type
- number
- Description
- Name
amountCents- Type
- integer
- Description
- Name
subtotalCents- Type
- integer
- Description
- Name
lineItemEntity- Type
- string
- Description
- Name
partId- Type
- string
- Description
- Name
laborId- Type
- string
- Description
- Name
subcontractId- Type
- string
- Description
- Name
tireId- Type
- string
- Description
- Name
name- Type
- string Required
- Description
- Name
ordinal- Type
- number
- Description
- Name
categoryId- Type
- string
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/service/:serviceId/feecurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/fee \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.391Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:serviceId/fee/:id
Delete Order Line Item
Delete an Order Line Item for fee
URL parameters
- Name
id- Type
- string Required
- Description
- the id for fee
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:serviceId/fee/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/fee/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.391Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/service/:serviceId/subcontract/:id
Update Order Line Item
Update an Order Line Item for subcontract
URL parameters
- Name
id- Type
- string Required
- Description
- the id for subcontract
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
discountCents- Type
- integer
- Description
- Name
discountPercent- Type
- number
- Description
- Name
discountValueType- Type
- string
- Description
- Name
taxable- Type
- boolean
- Description
- US specific
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
costCents- Type
- integer
- Description
- Name
retailCostCents- Type
- integer
- Description
- Name
showNote- Type
- boolean
- Description
- Show note on estimates and invoices
- Name
note- Type
- string
- Description
- Name
vendorId- Type
- string
- Description
- Name
serviceId- Type
- string
- Description
- Name
orderId- Type
- string
- Description
- Name
ordinal- Type
- number
- Description
- Name
categoryId- Type
- string
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:serviceId/subcontract/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/subcontract/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.392Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service/:serviceId/subcontract
Add Subcontract to Service
Add a Subcontract to a Service for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
name- Type
- string Required
- Description
- Name
discountCents- Type
- integer
- Description
- Name
discountPercent- Type
- number
- Description
- Name
discountValueType- Type
- string
- Description
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
costCents- Type
- integer
- Description
- Name
retailCostCents- Type
- integer
- Description
- Name
showNote- Type
- boolean
- Description
- Show note on estimates and invoices
- Name
note- Type
- string
- Description
- Name
vendorId- Type
- string
- Description
- Name
ordinal- Type
- number
- Description
- Name
categoryId- Type
- string
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
labels- Type
- undefined
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/service/:serviceId/subcontractcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/subcontract \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.392Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:serviceId/subcontract/:id
Delete Order Line Item
Delete an Order Line Item for subcontract
URL parameters
- Name
id- Type
- string Required
- Description
- the id for subcontract
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:serviceId/subcontract/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/subcontract/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.392Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
PUT/v3/order/:orderId/service/:serviceId/tire/:id
Update Order Line Item
Update an Order Line Item for tire
URL parameters
- Name
id- Type
- string Required
- Description
- the id for tire
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
note- Type
- string
- Description
- Name
pricingMatrixId- Type
- string
- Description
- 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
ordinal- Type
- number
- Description
- Name
sizeFormat- Type
- string
- Description
- Name
size- Type
- string
- Description
- Name
partNumber- Type
- string
- Description
- Name
binLocation- Type
- string
- Description
- Name
tireModelId- Type
- string
- Description
- Name
taxable- Type
- boolean
- Description
- US specific
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
showPartNumber- Type
- boolean
- Description
- show on estimates and invoices
- Name
showPriceAndQuantity- Type
- boolean
- Description
- show on estimates and invoices
- Name
showNote- Type
- boolean
- Description
- show on estimates and invoices
- Name
serviceId- Type
- string
- Description
- Name
orderId- Type
- string
- Description
- Name
reduceInventoryCount- Type
- boolean
- Description
- Name
reserved- Type
- boolean
- Description
- Name
inventoryStatus- Type
- string
- Description
- Name
federalExciseTaxCents- Type
- integer
- Description
- Name
wasteTireFee- Type
- integer
- Description
- Name
labels- Type
- undefined
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
inventoryTireId- Type
- string
- Description
- Name
tireIdentificationNumbers- Type
- array
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:orderId/service/:serviceId/tire/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/tire/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.393Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
POST/v3/order/:orderId/service/:serviceId/tire
Add Tire to Service
Add a Tire to a Service for an Order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
Body parameters
- Name
locationId- Type
- string
- Description
- Name
name- Type
- string Required
- Description
- Name
note- Type
- string
- Description
- 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
ordinal- Type
- number
- Description
- Name
sizeFormat- Type
- string
- Description
- Name
size- Type
- string
- Description
- Name
partNumber- Type
- string
- Description
- Name
binLocation- Type
- string
- Description
- Name
tireModelId- Type
- string
- Description
- Name
taxableGST- Type
- boolean
- Description
- CA specific
- Name
taxableHST- Type
- boolean
- Description
- CA specific
- Name
taxablePST- Type
- boolean
- Description
- CA specific
- Name
showPartNumber- Type
- boolean
- Description
- show on estimates and invoices
- Name
showPriceAndQuantity- Type
- boolean
- Description
- show on estimates and invoices
- Name
showNote- Type
- boolean
- Description
- show on estimates and invoices
- Name
reduceInventoryCount- Type
- boolean
- Description
- Name
reserved- Type
- boolean
- Description
- Name
inventoryStatus- Type
- string
- Description
- Name
federalExciseTaxCents- Type
- integer
- Description
- Name
wasteTireFee- Type
- integer
- Description
- Name
labels- Type
- undefined
- Description
- Name
sourceItemId- Type
- string
- Description
- Name
inventoryTireId- Type
- string
- Description
- Name
tireIdentificationNumbers- Type
- array
- 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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:orderId/service/:serviceId/tirecurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/tire \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.393Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
DELETE/v3/order/:orderId/service/:serviceId/tire/:id
Delete Order Line Item
Delete an Order Line Item for tire
URL parameters
- Name
id- Type
- string Required
- Description
- the id for tire
- Name
orderId- Type
- string Required
- Description
- the id for the order
- Name
serviceId- Type
- string Required
- Description
- the id for the service
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
Properties for data object
- Name
order- Type
- object Required
- Description
- Order schema
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
DELETE
/v3/order/:orderId/service/:serviceId/tire/:idcurl https://api.shopmonkey.cloud/v3/order/ORDERID/service/SERVICEID/tire/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.394Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
}
GET/v3/order/:orderId/part
Find Services Parts
Find all Services Parts and Purchase order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order/:orderId/partcurl https://api.shopmonkey.cloud/v3/order/ORDERID/part \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"reserved": true,
"name": "name",
"partNumber": null,
"inventoryPartId": null,
"purchaseOrderPartId": null,
"purchaseStatus": null,
"inventoryPart": {
"availableQuantity": 1,
"id": "id",
"name": "name",
"quantity": 1
},
"labelConnections": [
{
"label": {
"color": "color",
"id": "id",
"name": "name"
}
}
],
"purchaseOrderPart": {
"id": "id",
"name": "name",
"purchaseOrder": {
"id": "id",
"number": 1,
"provider": null,
"status": "status",
"vendor": {
"name": "name"
}
}
},
"service": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
],
"success": true
}
GET/v3/order/:orderId/tire
Find Services Tires
Find all Services Tires and Purchase order
URL parameters
- Name
orderId- Type
- string Required
- Description
- the id for the order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order/:orderId/tirecurl https://api.shopmonkey.cloud/v3/order/ORDERID/tire \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"name": "name",
"quantity": 1,
"retailCostCents": 1,
"wholesaleCostCents": null,
"sizeFormat": "sizeFormat",
"size": null,
"partNumber": null,
"tireModelId": null,
"purchaseOrderTireId": null,
"purchaseStatus": null,
"inventoryTireId": null,
"inventoryTire": {
"availableQuantity": 1,
"id": "id",
"name": "name",
"quantity": 1
},
"labelConnections": [
{
"label": {
"color": "color",
"id": "id",
"name": "name"
}
}
],
"purchaseOrderTire": {
"id": "id",
"name": "name",
"purchaseOrder": {
"id": "id",
"number": 1,
"provider": null,
"status": "status",
"vendor": {
"name": "name"
}
}
},
"service": {
"id": "id",
"name": "name"
}
}
],
"success": true
}
GET/v3/order/:id
Find Order
Find an Order by id
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the object
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
- Order schema
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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for meta object
- Name
userId- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId- Type
- string
- Description
- the session id for the most recent change
- Name
version- Type
- number
- Description
- a monotonically increasing number for the most recent change
Properties for customer object
- Name
id- 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
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for meta object
- Name
userId- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId- Type
- string
- Description
- the session id for the most recent change
- Name
version- Type
- number
- Description
- a monotonically increasing number for the most recent change
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- 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
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for meta object
- Name
userId- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId- Type
- string
- Description
- the session id for the most recent change
- Name
version- Type
- number
- Description
- a monotonically increasing number for the most recent change
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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
GET
/v3/order/:idcurl https://api.shopmonkey.cloud/v3/order/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"publicId": "publicId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"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.394Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
PUT/v3/order/:id
Update Order
Update an Order by id
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
locationId- Type
- string
- Description
- Name
externalNumber- Type
- string
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string
- Description
- Name
phoneNumberId- Type
- string
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
complaint- Type
- string
- Description
- Name
recommendation- Type
- string
- Description
- Name
purchaseOrderNumber- Type
- string
- Description
- Name
orderCreatedDate- Type
- string
- Description
- allow user to override created date
- Name
archived- Type
- boolean
- Description
- Name
invoiced- Type
- boolean
- Description
- Name
sentToCarfax- Type
- boolean
- Description
- Name
invoicedDate- Type
- string
- Description
- Name
requestedDepositCents- Type
- integer
- Description
- Name
workflowStatusId- Type
- string
- Description
- Name
workflowStatusPosition- Type
- number
- Description
- Name
dueDate- Type
- string
- Description
- Name
serviceWriterId- Type
- string
- Description
- Name
completedDate- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
- if the record has been deleted
- Name
deletedUserId- Type
- string
- Description
- the user that deleted the record or null if not deleted
- Name
deletedReason- Type
- string
- Description
- the reason that the record was deleted
- Name
readOnly- Type
- boolean
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
statementId- Type
- string
- Description
- a statement this order included in
- Name
paymentTermId- Type
- string
- Description
- id of the payment term for the order
- Name
allowCollectPayment- Type
- boolean
- Description
- Name
allowCustomerAuthorization- Type
- boolean
- Description
- Name
allowCustomerViewMessages- Type
- boolean
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean
- Description
- Name
allowCustomerViewActivity- Type
- boolean
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean
- Description
- Name
requireESignatureOnInvoice- Type
- boolean
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean
- Description
- Name
labels- Type
- undefined
- Description
- Name
imported- Type
- boolean
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
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
- Order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PUT
/v3/order/:idcurl https://api.shopmonkey.cloud/v3/order/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.395Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
PUT/v3/order/:id/customfield
Update Custom Fields
Update an Order Custom Fields
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
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
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 Requestapplication/json
PUT
/v3/order/:id/customfieldcurl https://api.shopmonkey.cloud/v3/order/ID/customfield \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id"
}
}
POST/v3/order
Create Order
Create a new Order
Body parameters
- Name
locationId- Type
- string
- Description
- Name
externalNumber- Type
- string
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string
- Description
- Name
phoneNumberId- Type
- string
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
complaint- Type
- string
- Description
- Name
recommendation- Type
- string
- Description
- Name
purchaseOrderNumber- Type
- string
- Description
- Name
orderCreatedDate- Type
- string
- Description
- allow user to override created date
- Name
archived- Type
- boolean
- Description
- Name
sentToCarfax- Type
- boolean
- Description
- Name
requestedDepositCents- Type
- integer
- Description
- Name
dueDate- Type
- string
- Description
- Name
serviceWriterId- Type
- string
- Description
- Name
completedDate- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
- if the record has been deleted
- Name
deletedUserId- Type
- string
- Description
- the user that deleted the record or null if not deleted
- Name
deletedReason- Type
- string
- Description
- the reason that the record was deleted
- Name
readOnly- Type
- boolean
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
statementId- Type
- string
- Description
- a statement this order included in
- Name
allowCollectPayment- Type
- boolean
- Description
- Name
allowCustomerAuthorization- Type
- boolean
- Description
- Name
allowCustomerViewMessages- Type
- boolean
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean
- Description
- Name
allowCustomerViewActivity- Type
- boolean
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean
- Description
- Name
requireESignatureOnInvoice- Type
- boolean
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean
- Description
- Name
labels- Type
- undefined
- Description
- Name
imported- Type
- boolean
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
workflowStatusId- Type
- string
- Description
- the id for the workflow status
- Name
workflowStatusPosition- Type
- number
- Description
- the position of the order in the workflow
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
- Order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/ordercurl https://api.shopmonkey.cloud/v3/order \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.395Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
POST/v3/order/new_estimate
Create Estimate
Create a new Order with one Service and one Labor line item
Body parameters
- Name
locationId- Type
- string
- Description
- Name
externalNumber- Type
- string
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string
- Description
- Name
phoneNumberId- Type
- string
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string
- Description
- Name
name- Type
- string
- Description
- Name
complaint- Type
- string
- Description
- Name
recommendation- Type
- string
- Description
- Name
purchaseOrderNumber- Type
- string
- Description
- Name
orderCreatedDate- Type
- string
- Description
- allow user to override created date
- Name
archived- Type
- boolean
- Description
- Name
sentToCarfax- Type
- boolean
- Description
- Name
requestedDepositCents- Type
- integer
- Description
- Name
dueDate- Type
- string
- Description
- Name
serviceWriterId- Type
- string
- Description
- Name
completedDate- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
- if the record has been deleted
- Name
deletedUserId- Type
- string
- Description
- the user that deleted the record or null if not deleted
- Name
deletedReason- Type
- string
- Description
- the reason that the record was deleted
- Name
readOnly- Type
- boolean
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
statementId- Type
- string
- Description
- a statement this order included in
- Name
allowCollectPayment- Type
- boolean
- Description
- Name
allowCustomerAuthorization- Type
- boolean
- Description
- Name
allowCustomerViewMessages- Type
- boolean
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean
- Description
- Name
allowCustomerViewActivity- Type
- boolean
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean
- Description
- Name
requireESignatureOnInvoice- Type
- boolean
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean
- Description
- Name
labels- Type
- undefined
- Description
- Name
imported- Type
- boolean
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
workflowStatusId- Type
- string
- Description
- the id for the workflow status
- Name
workflowStatusPosition- Type
- number
- Description
- the position of the order in the workflow
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
- Order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/new_estimatecurl https://api.shopmonkey.cloud/v3/order/new_estimate \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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-07-05T15:06:42.327Z",
"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,
"transactionalFeeTotalCents": 1,
"transactionalFeeSubtotalCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"workflowStatusDate": "workflowStatusDate",
"taxConfigId": "taxConfigId",
"transactionFeeConfigId": null,
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": null,
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"fullyPaidDate": null,
"messagedDate": null,
"paymentTermId": "paymentTermId",
"paymentDueDate": null,
"allowCollectPayment": true,
"allowCustomerAuthorization": true,
"allowCustomerESign": true,
"allowCustomerViewMessages": true,
"allowCustomerViewAuthorizations": true,
"allowCustomerViewActivity": true,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": null,
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"website": null,
"normalizedFirstName": null,
"normalizedLastName": null,
"normalizedName": null,
"vehicleCount": 1,
"orderCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"email": "email",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"number": "number",
"extension": null,
"type": null,
"userDefinedType": null,
"primary": true
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"computed_ymm": null,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"inventoryTireId": null,
"tireIdentificationNumbers": [
"tireIdentificationNumbers"
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
],
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"duration": null,
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId",
"confirmationSubject": null,
"confirmationText": null,
"reminderSubject": null,
"reminderText": null,
"confirmationStatus": "confirmationStatus"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"name": null
},
"paymentTerm": {
"id": "id",
"name": "name"
}
}
}
POST/v3/order/:id/calculated_pricing
Calculate Prices
Calculate prices for an order by id given approved service ids
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
authorizedServiceIds- Type
- array Required
- 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
- Order schema
Properties for data object
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
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 Requestapplication/json
POST
/v3/order/:id/calculated_pricingcurl https://api.shopmonkey.cloud/v3/order/ID/calculated_pricing \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "authorizedServiceIds" : [] }'
Example Responseapplication/json
{
"success": true,
"data": {
"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,
"transactionalFeeTotalCents": 1,
"transactionalFeeSubtotalCents": 1
}
}
DELETE/v3/order/:id
Delete Order
Permanently delete a Order 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 Requestapplication/json
DELETE
/v3/order/:idcurl https://api.shopmonkey.cloud/v3/order/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
PATCH/v3/order/:id/:action
Soft Delete Order
Soft delete or undelete a Order 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
- Order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
PATCH
/v3/order/:id/:actioncurl https://api.shopmonkey.cloud/v3/order/ID/ACTION \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PATCH -H 'Content-Type: application/json' \
--data '{ "reason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.396Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
}
}
PUT/v3/order/:id/move
Move Order
Move an Order to a different column in the Workflow
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
after- Type
- number
- Description
- the position offset to move after
- Name
before- Type
- number
- Description
- the position offset to move before
- Name
workflowStatusId- Type
- string Required
- Description
- the id for the workflow status
200 Response
- Name
data- Type
- object Required
- 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 data object
- Name
workflowStatusPosition- Type
- number Required
- Description
- the new workflow position offset
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 Requestapplication/json
PUT
/v3/order/:id/movecurl https://api.shopmonkey.cloud/v3/order/ID/move \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "workflowStatusId" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"workflowStatusPosition": 1
}
}
GET/v3/order/:id/authorization
Find Authorizations
Find all Authorizations for an Order
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order/:id/authorizationcurl https://api.shopmonkey.cloud/v3/order/ID/authorization \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note",
"services": [
{
"id": "id",
"serviceId": "serviceId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"authorizationId": "authorizationId",
"authorizationStatus": "authorizationStatus",
"authorizedCostCents": 1
}
]
}
]
}
POST/v3/order/:id/authorization
Create Authorization
Create a new Authorization for an Order
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
authorized- Type
- array
- Description
- Name
declined- Type
- array
- Description
- Name
notAuthorized- Type
- array
- Description
- Name
date- Type
- string Required
- Description
- Name
customerId- Type
- string
- Description
- Name
method- Type
- string Required
- Description
- Name
note- 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
Properties for data object
- Name
authorization- Type
- object Required
- Description
- Authorization schema
- Name
order- Type
- object Required
- Description
- Order schema
Properties for authorization object
- Name
id- 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
orderId- Type
- string Required
- Description
- Name
date- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
customerId- Type
- string Required
- Description
- Name
method- Type
- string Required
- Description
- Name
authorizedCostCents- Type
- integer Required
- Description
- Name
note- Type
- string Required
- Description
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
appointments- Type
- array Required
- Description
- Deprecated: will return []
- Name
authorizations- Type
- array Required
- Description
- Deprecated: will return []
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
customer- Type
- object Required
- Description
- Name
inspections- Type
- array Required
- Description
- Deprecated: will return []
- Name
labelConnections- Type
- array Required
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
profitability- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Soon will be deprecated!
- Name
vehicle- Type
- object Required
- Description
- Name
workflowStatus- Type
- object Required
- Description
- WorkflowStatus schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for profitability object
- Name
labor- Type
- object Required
- Description
- Name
parts- Type
- object Required
- Description
- Name
subcontracts- Type
- object Required
- Description
- Name
tires- Type
- object Required
- Description
- Name
totalDiscountCents- Type
- number Required
- Description
- Name
totalDiscountPercent- Type
- number Required
- Description
- Name
totalProfitCents- Type
- number Required
- Description
- Name
totalProfitPercent- Type
- number Required
- Description
- Name
totalRetailCents- Type
- number Required
- Description
- Name
totalWholesaleCents- Type
- number Required
- Description
Properties for labor object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for parts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for subcontracts object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for tires object
- Name
discountCents- Type
- number Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
profitCents- Type
- number Required
- Description
- Name
profitPercent- Type
- number Required
- Description
- Name
retailCents- Type
- number Required
- Description
- Name
wholesaleCents- Type
- number Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
labelConnections- Type
- array Required
- Description
- Name
customFields- Type
- object
- Description
- custom fields as JSON object
- Name
tirePressureLogs- Type
- array
- Description
Properties for workflowStatus object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order/:id/authorizationcurl https://api.shopmonkey.cloud/v3/order/ID/authorization \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "date" : "value", "method" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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.396Z",
"assignedTechnicianIds": [
"assignedTechnicianIds"
],
"messageCount": 1,
"shopUnreadMessageCount": 1,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"subcontractsCents": 1,
"epaCents": 1,
"discountCents": 1,
"discountPercent": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"gstCents": 1,
"pstCents": 1,
"hstCents": 1,
"workflowStatusId": "workflowStatusId",
"workflowStatusPosition": 1,
"taxConfigId": "taxConfigId",
"dueDate": null,
"serviceWriterId": null,
"mileageIn": null,
"mileageOut": null,
"conversationId": "conversationId",
"completedDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"readOnly": true,
"readOnlyReason": null,
"deferredServiceCount": 1,
"statementId": null,
"customFields": {},
"profitability": {
"parts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"labor": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"subcontracts": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"tires": {
"discountPercent": 1,
"discountCents": 1,
"profitCents": 1,
"profitPercent": 1,
"retailCents": 1,
"wholesaleCents": 1
},
"totalProfitPercent": 1,
"totalProfitCents": 1,
"totalRetailCents": 1,
"totalWholesaleCents": 1,
"totalDiscountCents": 1,
"totalDiscountPercent": 1
},
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
],
"customFields": {}
},
"vehicle": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"size": "size",
"type": null,
"year": null,
"make": null,
"makeId": null,
"model": null,
"modelId": null,
"submodel": null,
"submodelId": null,
"engine": null,
"productionDate": null,
"transmission": null,
"drivetrain": null,
"vin": null,
"color": null,
"unit": null,
"mileage": null,
"mileageUnit": "mileageUnit",
"odometer": true,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry",
"note": "note",
"vcdbVehicleId": null,
"ownerCount": 1,
"orderCount": 1,
"appointmentCount": 1,
"tirePressureLogCount": 1,
"mileageLogCount": 1,
"deferredServiceCount": 1,
"messageCount": 1,
"customPhoto": true,
"stockPhoto": true,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"tirePressureLogs": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"vehicleId": "vehicleId",
"frontLeft": null,
"frontRight": null,
"rearLeft": null,
"rearRight": null
}
],
"customFields": {}
},
"appointments": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"startDate": "startDate",
"endDate": "endDate",
"rruleset": null,
"customerId": null,
"note": "note",
"vehicleId": null,
"orderId": null,
"color": "color",
"useEmail": true,
"useSMS": true,
"sendConfirmation": true,
"sendReminder": true,
"cancelationNote": null,
"pendingConfirmation": true,
"confirmed": true,
"allDay": true,
"removedFromRecurrency": true,
"customerEmailId": null,
"customerPhoneNumberId": null,
"locationId": "locationId"
}
],
"inspections": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"name": "name",
"createdById": null,
"templateId": null,
"completed": true,
"completedDate": null,
"completedById": null,
"ordinal": 1
}
],
"authorizations": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
],
"workflowStatus": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": null,
"position": 1,
"daysToArchive": 1,
"archiveWhenInactive": true,
"invoiceWorkflow": true
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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"
}
}
}
],
"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,
"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",
"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,
"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"
}
}
],
"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,
"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"
}
}
],
"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,
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"brand": {
"id": "id",
"name": "name"
},
"pricingMatrix": {
"id": "id",
"name": "name"
},
"vendor": {
"id": "id",
"name": "name"
}
}
]
}
]
},
"authorization": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
}
}
PUT/v3/order/:id/authorization/:authorizationId
Edit Authorization Metadata
Edit the metadata fields on an Authorization
URL parameters
- Name
authorizationId- Type
- string Required
- Description
- the id for the authorization
- Name
id- Type
- string Required
- Description
- the id for the order
Body parameters
- Name
date- Type
- string
- Description
- Name
customerId- Type
- string
- Description
- Name
method- Type
- string
- Description
- Name
note- Type
- string
- Description
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 Requestapplication/json
PUT
/v3/order/:id/authorization/:authorizationIdcurl https://api.shopmonkey.cloud/v3/order/ID/authorization/AUTHORIZATIONID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
GET/v3/order/:id/pdf
Download PDF
Get an order as PDF document
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the object
Example Request
GET
/v3/order/:id/pdfcurl https://api.shopmonkey.cloud/v3/order/ID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
GET/v3/report/order
All Orders report
All Orders report
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- Name
total- Type
- number Required
- Description
- the total number of records
- Name
epaCents- Type
- number
- Description
- Name
feesCents- Type
- number
- Description
- Name
laborCostCents- Type
- number
- Description
- Name
laborRetailCents- Type
- number
- Description
- Name
laborWholesaleCents- Type
- number
- Description
- Name
paidCostCents- Type
- number
- Description
- Name
partsRetailCents- Type
- number
- Description
- Name
partsWholesaleCents- Type
- number
- Description
- Name
remainingCostCents- Type
- number
- Description
- Name
shopSuppliesCents- Type
- number
- Description
- Name
subcontractsRetailCents- Type
- number
- Description
- Name
subcontractsWholesaleCents- Type
- number
- Description
- Name
taxCents- Type
- number
- Description
- Name
tiresRetailCents- Type
- number
- Description
- Name
tiresWholesaleCents- Type
- number
- Description
- Name
totalCostCents- Type
- number
- Description
- Name
totalDiscountCents- Type
- number
- Description
- Name
totalProfitCents- Type
- number
- Description
- Name
totalRetailCents- Type
- number
- Description
- Name
totalWholesaleCents- Type
- number
- 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
GET
/v3/report/ordercurl https://api.shopmonkey.cloud/v3/report/order \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"companyId": "companyId",
"number": 1,
"name": null,
"purchaseOrderNumber": null,
"generatedVehicleName": null,
"archived": true,
"authorized": true,
"invoiced": true,
"invoicedDate": null,
"paid": true,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null,
"partsCents": 1,
"tiresCents": 1,
"laborCents": 1,
"epaCents": 1,
"shopSuppliesCents": 1,
"feesCents": 1,
"taxCents": 1,
"dueDate": null,
"completedDate": null,
"fullyPaidDate": null,
"customer": {
"id": "id",
"firstName": null,
"lastName": null,
"companyName": null,
"normalizedFirstName": null,
"normalizedLastName": null
},
"laborHours": 1,
"lastPaymentPosted": null,
"location": {
"id": "id",
"name": "name"
},
"paymentTypes": [
"paymentTypes"
],
"paymentTerm": {
"id": "id",
"name": "name"
},
"serviceWriter": {
"id": "id",
"firstName": "firstName",
"lastName": "lastName"
},
"workflowStatus": {
"id": "id",
"name": null
},
"vehicle": {
"id": "id",
"vin": null,
"unit": null,
"licensePlate": null,
"licensePlateState": null,
"licensePlateCountry": "licensePlateCountry"
}
}
]
}
GET/v3/order_shared/:publicId/pdf
Download PDF
Get an order as PDF document
Example Request
GET
/v3/order_shared/:publicId/pdfcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
GET/v3/order_shared/:publicId/message
Find Messages
Find Messages for an Order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order_shared/:publicId/messagecurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/message \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"text": "text",
"sendEmail": true,
"emailSubject": null,
"emailStatus": null,
"emailError": null,
"sendSms": true,
"smsStatus": null,
"smsError": null,
"authorType": "authorType",
"origin": "origin",
"isOrderShare": true,
"customerId": null,
"userId": null,
"orderId": null,
"vehicleId": null,
"vendorId": null,
"shopRead": true,
"internal": true,
"detached": true,
"conversationId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"files": [
{
"id": "id",
"url": "url",
"thumbnailUrl": "thumbnailUrl",
"fileSize": 1,
"fileType": "fileType",
"fileName": "fileName"
}
],
"user": {
"firstName": "firstName",
"lastName": "lastName",
"id": "id"
}
}
]
}
POST/v3/order_shared/:publicId/message
Customer Message
Send Customer's Message
Body parameters
- Name
text- Type
- string Required
- Description
- Name
files- Type
- array
- Description
- an ordered array of file ids
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
- Message schema
Properties for data object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
locationId- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
text- Type
- string Required
- Description
- appears in message center/thread (content of message if SMS, plaintext/preview if email)
- Name
sendEmail- Type
- boolean Required
- Description
- if an email should be sent, is null if author is a Customer
- Name
emailSubject- Type
- string Required
- Description
- overrides default email subject
- Name
emailStatus- Type
- string Required
- Description
- Name
emailError- Type
- string Required
- Description
- error sending email, if any
- Name
sendSms- Type
- boolean Required
- Description
- if an sms should be sent, is null if author is a Customer
- Name
smsStatus- Type
- string Required
- Description
- Name
smsError- Type
- string Required
- Description
- error sending sms, if any
- Name
authorType- Type
- string Required
- Description
- Name
origin- Type
- string Required
- Description
- Name
isOrderShare- Type
- boolean Required
- Description
- true if this message created via Order Share modal
- Name
orderShareType- Type
- string Required
- Description
- Name
customerId- Type
- string Required
- Description
- the id of the customer that authored or was sent the message
- Name
userId- Type
- string Required
- Description
- the user who authored the message
- Name
orderId- Type
- string Required
- Description
- an order associated with this message
- Name
appointmentId- Type
- string Required
- Description
- appointment associated with this message
- Name
vehicleId- Type
- string Required
- Description
- a vehicle associated with this message
- Name
vendorId- Type
- string Required
- Description
- a vendor associated with this message
- Name
shopRead- Type
- boolean Required
- Description
- true if someone at the shop has read a Customer message, is null if author is a User
- Name
internal- Type
- boolean Required
- Description
- true if internal note, is null if author is a Customer
- Name
detached- Type
- boolean Required
- Description
- true if message is public but has no reference to a customer (only for migration purposes)
- Name
conversationId- Type
- string 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
locationReviewRequestId- Type
- string Required
- Description
- the id of the review request
- Name
suggestedReply- Type
- string Required
- Description
- if we can suggest a reply, this will have a value to suggest to the user in the app
- Name
suggestedReplyState- Type
- string Required
- Description
- Name
requestAppointmentConfirmation- Type
- boolean Required
- Description
- if true, the email/sms will contain actions to confirm/decline an appointment
- Name
appointmentEvent- Type
- string Required
- Description
- Name
avoidSMSQuietHours- Type
- boolean Required
- Description
- Name
files- Type
- array Required
- Description
- Name
orderNumber- Type
- string
- Description
- the order number
- Name
userColor- Type
- string
- Description
- the color for the user
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 Requestapplication/json
POST
/v3/order_shared/:publicId/messagecurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/message \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "text" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"text": "text",
"sendEmail": true,
"emailSubject": null,
"emailStatus": null,
"emailError": null,
"sendSms": true,
"smsStatus": null,
"smsError": null,
"authorType": "authorType",
"origin": "origin",
"isOrderShare": true,
"customerId": null,
"userId": null,
"orderId": null,
"vehicleId": null,
"vendorId": null,
"shopRead": true,
"internal": true,
"detached": true,
"conversationId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"files": [
{
"id": "id",
"url": "url",
"thumbnailUrl": "thumbnailUrl",
"fileSize": 1,
"fileType": "fileType",
"fileName": "fileName"
}
]
}
}
GET/v3/order_shared/:publicId/authorization
Find Authorizations
Find Authorizations for an Order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order_shared/:publicId/authorizationcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/authorization \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note",
"services": [
{
"id": "id",
"serviceId": "serviceId",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"authorizationId": "authorizationId",
"authorizationStatus": "authorizationStatus",
"authorizedCostCents": 1
}
]
}
]
}
POST/v3/order_shared/:publicId/authorization
Create InApp Authorization
Create a new InApp authorization for an Order
Body parameters
- Name
authorized- Type
- array
- Description
- Name
declined- Type
- array
- Description
- Name
eSignatureImage- Type
- string
- Description
- the e-signature as Base64 string
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
Properties for data object
- Name
authorization- Type
- object Required
- Description
- Authorization schema
- Name
order- Type
- object Required
- Description
- Order schema
Properties for authorization object
- Name
id- 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
orderId- Type
- string Required
- Description
- Name
date- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
customerId- Type
- string Required
- Description
- Name
method- Type
- string Required
- Description
- Name
authorizedCostCents- Type
- integer Required
- Description
- Name
note- Type
- string Required
- Description
Properties for order 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
number- Type
- string Required
- Description
- Name
externalNumber- Type
- string Required
- Description
- allow user to override generated number
- Name
vehicleId- Type
- string Required
- Description
- Name
phoneNumberId- Type
- string Required
- Description
- id of the phone number to use instead of the customer's default number
- Name
emailId- Type
- string Required
- Description
- id of the email to use instead of the customer's default email
- Name
customerId- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
generatedName- Type
- string Required
- Description
- Name
coalescedName- Type
- string Required
- Description
- Name
complaint- Type
- string Required
- Description
- Name
recommendation- Type
- string Required
- Description
- Name
purchaseOrderNumber- Type
- string Required
- Description
- Name
generatedVehicleName- Type
- string Required
- Description
- "[year] [make] [model] [submodel]" pulled from the vehicle, if any
- Name
generatedCustomerName- Type
- string Required
- Description
- "[firstName] [lastName]" pulled from the customer, if any
- Name
orderCreatedDate- Type
- string Required
- Description
- allow user to override created date
- Name
archived- Type
- boolean Required
- Description
- Name
authorized- Type
- boolean Required
- Description
- Name
authorizedDate- Type
- string Required
- Description
- Name
invoiced- Type
- boolean Required
- Description
- Name
sentToCarfax- Type
- boolean Required
- Description
- Name
inspectionStatus- Type
- string Required
- Description
- Name
inspectionCount- Type
- integer Required
- Description
- Name
invoicedDate- Type
- string Required
- Description
- Name
paid- Type
- boolean Required
- Description
- Name
appointmentDates- Type
- array Required
- Description
- Name
assignedTechnicianIds- Type
- array Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
shopUnreadMessageCount- Type
- integer Required
- Description
- Name
totalCostCents- Type
- integer Required
- Description
- Name
paidCostCents- Type
- integer Required
- Description
- Name
remainingCostCents- Type
- integer Required
- Description
- Name
partsCents- Type
- integer Required
- Description
- Name
tiresCents- Type
- integer Required
- Description
- Name
laborCents- Type
- integer Required
- Description
- Name
subcontractsCents- Type
- integer Required
- Description
- Name
epaCents- Type
- integer Required
- Description
- Name
discountCents- Type
- integer Required
- Description
- Name
discountPercent- Type
- number Required
- Description
- Name
shopSuppliesCents- Type
- integer Required
- Description
- Name
feesCents- Type
- integer Required
- Description
- Name
taxCents- Type
- integer Required
- Description
- Name
gstCents- Type
- integer Required
- Description
- Name
pstCents- Type
- integer Required
- Description
- Name
hstCents- Type
- integer Required
- Description
- Name
transactionalFeeTotalCents- Type
- integer Required
- Description
- Name
transactionalFeeSubtotalCents- Type
- integer Required
- Description
- // value before taxes
- Name
requestedDepositCents- Type
- integer Required
- Description
- Name
workflowStatusId- Type
- string Required
- Description
- Name
workflowStatusPosition- Type
- number Required
- Description
- Name
workflowStatusDate- Type
- string Required
- Description
- Name
taxConfigId- Type
- string Required
- Description
- Name
transactionFeeConfigId- Type
- string Required
- Description
- Name
dueDate- Type
- string Required
- Description
- Name
serviceWriterId- Type
- string Required
- Description
- Name
mileageIn- Type
- number Required
- Description
- Name
mileageOut- Type
- number Required
- Description
- Name
conversationId- Type
- string Required
- Description
- Name
completedDate- Type
- string Required
- Description
- Name
customFields- Type
- object
- Description
- custom field values
- 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
readOnly- Type
- boolean Required
- Description
- if this order should not be editable in the UI
- Name
readOnlyReason- Type
- string Required
- Description
- a friendly explanation of why (eg. "migrated from previous system")
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
statementId- Type
- string Required
- Description
- a statement this order included in
- Name
fullyPaidDate- Type
- string Required
- Description
- Name
messagedDate- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- id of the payment term for the order
- Name
paymentDueDate- Type
- string Required
- Description
- Name
allowCollectPayment- Type
- boolean Required
- Description
- Name
allowCustomerAuthorization- Type
- boolean Required
- Description
- Name
allowCustomerViewMessages- Type
- boolean Required
- Description
- Name
allowCustomerViewAuthorizations- Type
- boolean Required
- Description
- Name
allowCustomerViewActivity- Type
- boolean Required
- Description
- Name
requireESignatureOnAuthorization- Type
- boolean Required
- Description
- Name
requireESignatureOnInvoice- Type
- boolean Required
- Description
- Name
updatedSinceSignedInvoice- Type
- boolean Required
- Description
- Name
labels- Type
- undefined Required
- Description
- Name
imported- Type
- boolean Required
- Description
- Name
assignedTechnicians- Type
- array Required
- Description
- Name
customer- Type
- object Required
- Description
- Name
location- Type
- object Required
- Description
- Name
locationConfig- Type
- object Required
- Description
- Name
paymentConfig- Type
- object
- Description
- Name
paymentTerm- Type
- object Required
- Description
- Name
services- Type
- array Required
- Description
- Name
vehicle- Type
- object Required
- Description
- Vehicle schema
Properties for customer object
- Name
id- Type
- string Required
- Description
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
customerType- Type
- string Required
- Description
- Name
firstName- Type
- string Required
- Description
- Name
lastName- Type
- string Required
- Description
- Name
companyName- Type
- string Required
- Description
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
city- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
dotNumber- Type
- string Required
- Description
- Name
paymentTermId- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
marketingOptIn- Type
- boolean Required
- Description
- Name
preferredContactMethod- Type
- string Required
- Description
- Name
referralSourceId- Type
- string Required
- Description
- Name
taxExempt- Type
- boolean Required
- Description
- US specific
- Name
gstExempt- Type
- boolean Required
- Description
- CA specific
- Name
hstExempt- Type
- boolean Required
- Description
- CA specific
- Name
pstExempt- Type
- boolean Required
- Description
- CA specific
- Name
discountPercent- Type
- number Required
- Description
- Name
laborRateId- Type
- string Required
- Description
- Name
laborMatrixId- Type
- string Required
- Description
- Name
pricingMatrixId- Type
- string Required
- Description
- Name
fleetId- Type
- string Required
- Description
- Name
lastTimeOrderWorked- Type
- string Required
- Description
- Name
customFields- Type
- object
- Description
- custom field values
- Name
statementCount- Type
- integer Required
- Description
- Name
transactionCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
website- Type
- string Required
- Description
- Name
normalizedFirstName- Type
- string Required
- Description
- Name
normalizedLastName- Type
- string Required
- Description
- Name
normalizedName- Type
- string Required
- Description
- if fleet, contains the normalized companyName, else normalized firstName lastName
- Name
vehicleCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
finixIdentityId- Type
- string Required
- Description
- Name
labels- Type
- undefined 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
emails- Type
- array Required
- Description
- Name
phoneNumbers- Type
- array Required
- Description
Properties for location object
- Name
address1- Type
- string Required
- Description
- Name
address2- Type
- string Required
- Description
- Name
certifications- Type
- object Required
- Description
- Name
city- Type
- string Required
- Description
- Name
country- Type
- string Required
- Description
- Name
email- Type
- string Required
- Description
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
- Name
phone- Type
- string Required
- Description
- Name
postalCode- Type
- string Required
- Description
- Name
state- Type
- string Required
- Description
- Name
website- Type
- string Required
- Description
Properties for locationConfig object
- Name
estimateFooter- Type
- string Required
- Description
- Name
invoiceFooter- Type
- string Required
- Description
Properties for paymentConfig object
- Name
provider- Type
- one of: 'Finix', 'FirstMile', 'Manual', 'Stripe' Required
- Description
- the payment provider for the company
- Name
status- Type
- one of: 'NotAvailable', 'NotConfigured', 'Pending', 'Configured' Required
- Description
Properties for paymentTerm object
- Name
id- Type
- string Required
- Description
- Name
name- Type
- string Required
- Description
Properties for vehicle object
- Name
id- Type
- string Required
- Description
- ()
- Name
createdDate- Type
- string Required
- Description
- Name
updatedDate- Type
- string Required
- Description
- Name
companyId- Type
- string Required
- Description
- Name
size- Type
- string Required
- Description
- Name
type- Type
- string Required
- Description
- Name
year- Type
- integer Required
- Description
- Name
make- Type
- string Required
- Description
- Name
makeId- Type
- integer Required
- Description
- vcdb make id
- Name
model- Type
- string Required
- Description
- Name
modelId- Type
- integer Required
- Description
- vcdb model id
- Name
submodel- Type
- string Required
- Description
- Name
submodelId- Type
- integer Required
- Description
- vcdb submodel id
- Name
engine- Type
- string Required
- Description
- Name
productionDate- Type
- string Required
- Description
- Name
transmission- Type
- string Required
- Description
- Name
transmissionId- Type
- integer Required
- Description
- vcdb transmission id
- Name
drivetrain- Type
- string Required
- Description
- Name
bodyStyle- Type
- string Required
- Description
- Name
bedLength- Type
- string Required
- Description
- Name
vin- Type
- string Required
- Description
- Name
color- Type
- string Required
- Description
- Name
unit- Type
- string Required
- Description
- Name
mileage- Type
- number Required
- Description
- Name
mileageUnit- Type
- string Required
- Description
- Name
odometer- Type
- boolean Required
- Description
- Name
licensePlate- Type
- string Required
- Description
- Name
licensePlateState- Type
- string Required
- Description
- Name
licensePlateCountry- Type
- string Required
- Description
- Name
note- Type
- string Required
- Description
- Name
vcdbVehicleId- Type
- string Required
- Description
- Name
ownerCount- Type
- integer Required
- Description
- Name
orderCount- Type
- integer Required
- Description
- Name
appointmentCount- Type
- integer Required
- Description
- Name
tirePressureLogCount- Type
- integer Required
- Description
- Name
mileageLogCount- Type
- integer Required
- Description
- Name
deferredServiceCount- Type
- integer Required
- Description
- Name
messageCount- Type
- integer Required
- Description
- Name
customFields- Type
- object
- Description
- custom field values
- Name
computed_ymm- Type
- string Required
- Description
- Name
customPhoto- Type
- boolean Required
- Description
- Name
stockPhoto- Type
- boolean Required
- Description
- Name
labels- Type
- undefined 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
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 Requestapplication/json
POST
/v3/order_shared/:publicId/authorizationcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/authorization \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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.397Z",
"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,
"customer": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"customerType": "customerType",
"firstName": null,
"lastName": null,
"companyName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"dotNumber": null,
"paymentTermId": "paymentTermId",
"note": "note",
"marketingOptIn": true,
"preferredContactMethod": null,
"referralSourceId": null,
"taxExempt": true,
"discountPercent": 1,
"laborRateId": null,
"laborMatrixId": null,
"pricingMatrixId": null,
"fleetId": null,
"lastTimeOrderWorked": null,
"statementCount": 1,
"transactionCount": 1,
"deferredServiceCount": 1,
"appointmentCount": 1,
"messageCount": 1,
"emails": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"email": "email",
"subscribed": true,
"customerId": "customerId",
"primary": true
}
],
"phoneNumbers": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"locationId": "locationId",
"companyId": "companyId",
"customerId": "customerId",
"number": "number",
"extension": null,
"country": null,
"type": null,
"userDefinedType": null,
"carrierName": null,
"optInVerifiedDate": null,
"optIn": true,
"lastVerifiedDate": null,
"primary": true,
"mobileCountryCode": null,
"mobileNetworkCode": null
}
]
},
"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
},
"services": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": "note",
"orderId": "orderId",
"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",
"authorizationStatus": "authorizationStatus",
"calculatedPartsCents": 1,
"calculatedTiresCents": 1,
"calculatedLaborCents": 1,
"calculatedSubcontractsCents": 1,
"calculatedFeeCents": 1,
"calculatedEpaCents": 1,
"calculatedDiscountCents": 1,
"calculatedDiscountPercent": 1,
"calculatedShopSuppliesCents": 1,
"calculatedTaxCents": 1,
"ordinal": 1,
"hidden": true,
"totalCents": 1,
"sourceServiceId": null,
"deferredDate": null,
"deferredReason": null,
"excludedFromDeferred": true,
"revived": true,
"revivedFromId": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"serviceId": "serviceId",
"orderId": "orderId",
"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
}
],
"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
}
],
"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
}
],
"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
}
],
"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,
"brand": {
"id": "id",
"name": "name"
}
}
]
}
]
},
"authorization": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"date": "date",
"serviceWriterId": null,
"customerId": null,
"method": "method",
"authorizedCostCents": 1,
"note": "note"
}
}
}
GET/v3/order_shared/:publicId/signed_invoice
Get Signed Invoices
Get signed invoices for an Order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order_shared/:publicId/signed_invoicecurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/signed_invoice \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"orderTotalCostCents": 1,
"eSignatureBlobId": "eSignatureBlobId",
"orderPdfDocBlobId": "orderPdfDocBlobId",
"eSignatureUrl": "eSignatureUrl"
}
],
"success": true
}
GET/v3/order_shared/:publicId/signed_invoice/latest
Get Latest Signed Invoice
Get latest signed invoice for an Order
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
Properties for data object
- Name
id- 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
orderId- Type
- string Required
- Description
- id of the order
- Name
orderTotalCostCents- Type
- integer Required
- Description
- the total cost of the invoice at time of signing
- Name
eSignatureBlobId- Type
- string Required
- Description
- id of the e-signature blob
- Name
orderPdfDocBlobId- Type
- string Required
- Description
- id of the order PDF blob
- Name
eSignatureUrl- Type
- string Required
- Description
Properties for meta object
- Name
userId- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId- Type
- string
- Description
- the session id for the most recent change
- Name
version- Type
- number
- Description
- a monotonically increasing number for the most recent change
4xx Response
- Name
code- Type
- string
- Description
- The error code
- Name
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/order_shared/:publicId/signed_invoice/latestcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/signed_invoice/latest \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"orderTotalCostCents": 1,
"eSignatureBlobId": "eSignatureBlobId",
"orderPdfDocBlobId": "orderPdfDocBlobId",
"eSignatureUrl": "eSignatureUrl"
}
}
GET/v3/order_shared/:publicId/signed_invoice/:id
Get Signed Invoice
Get signed invoice for an Order by id
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the object
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
Properties for data object
- Name
id- 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
orderId- Type
- string Required
- Description
- id of the order
- Name
orderTotalCostCents- Type
- integer Required
- Description
- the total cost of the invoice at time of signing
- Name
eSignatureBlobId- Type
- string Required
- Description
- id of the e-signature blob
- Name
orderPdfDocBlobId- Type
- string Required
- Description
- id of the order PDF blob
- Name
eSignatureUrl- Type
- string Required
- Description
Properties for meta object
- Name
userId- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId- Type
- string
- Description
- the session id for the most recent change
- Name
version- Type
- number
- Description
- a monotonically increasing number for the most recent change
4xx Response
- Name
code- Type
- string
- Description
- The error code
- Name
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/order_shared/:publicId/signed_invoice/:idcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/signed_invoice/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"orderTotalCostCents": 1,
"eSignatureBlobId": "eSignatureBlobId",
"orderPdfDocBlobId": "orderPdfDocBlobId",
"eSignatureUrl": "eSignatureUrl"
}
}
GET/v3/order_shared/:publicId/signed_invoice/:id/pdf
Download Signed Invoice PDF
Get a signed invoice PDF document
URL parameters
- Name
id- Type
- string Required
- Description
- the id for the object
Example Request
GET
/v3/order_shared/:publicId/signed_invoice/:id/pdfcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/signed_invoice/ID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
POST/v3/order_shared/:publicId/signed_invoice
Create Signed Invoice
Create a new signed invoice for an Order
Body parameters
- Name
eSignatureImage- Type
- string Required
- Description
- the e-signature as Base64 string
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
Properties for data object
- Name
id- 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
orderId- Type
- string Required
- Description
- id of the order
- Name
orderTotalCostCents- Type
- integer Required
- Description
- the total cost of the invoice at time of signing
- Name
eSignatureBlobId- Type
- string Required
- Description
- id of the e-signature blob
- Name
orderPdfDocBlobId- Type
- string Required
- Description
- id of the order PDF blob
- Name
eSignatureUrl- Type
- string Required
- 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 Requestapplication/json
POST
/v3/order_shared/:publicId/signed_invoicecurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/signed_invoice \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "eSignatureImage" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"orderTotalCostCents": 1,
"eSignatureBlobId": "eSignatureBlobId",
"orderPdfDocBlobId": "orderPdfDocBlobId",
"eSignatureUrl": "eSignatureUrl"
}
}
GET/v3/order_shared/:publicId/payment
Find Payments
Find all Payments for an Order
200 Response
- Name
code- Type
- string
- Description
- The error code
- Name
data- Type
- array Required
- Description
- Name
documentation_url- Type
- string
- Description
- An optional link to the documentation for the error
- Name
meta- Type
- object
- Description
- Name
success- Type
- boolean Required
- Description
Properties for meta object
- Name
hasMore- Type
- boolean Required
- Description
- if there are more records available
- Name
sums- Type
- object
- Description
- 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/order_shared/:publicId/paymentcurl https://api.shopmonkey.cloud/v3/order_shared/PUBLICID/payment \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"orderId": "orderId",
"recordedDate": null,
"paymentType": "paymentType",
"paymentMode": "paymentMode",
"transactionType": "transactionType",
"amountCents": 1,
"deposit": true,
"checkNumber": null,
"cardType": null,
"cardDigits": null,
"receiptNumber": 1
}
],
"success": true
}