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
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
meta
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
GET
/v3/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
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
GET
/v3/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
Consumes
The following content type is required: application/json
- 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
- one of: Percent, FixedCents
- Description
- Name
discountCents
- Type
- integer
- Description
- Name
discountPercent
- Type
- number
- Description
- Name
discountValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
taxCents
- Type
- integer
- Description
- Name
taxPercent
- Type
- number
- Description
- Name
taxValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
gstCents
- Type
- integer
- Description
- Name
gstPercent
- Type
- number
- Description
- Name
gstValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
pstCents
- Type
- integer
- Description
- Name
pstPercent
- Type
- number
- Description
- Name
pstValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
hstCents
- Type
- integer
- Description
- Name
hstPercent
- Type
- number
- Description
- Name
hstValueType
- Type
- one of: Percent, FixedCents
- 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
- one of: Percent, FixedCents
- Description
- Name
authorizationStatus
- Type
- one of: NotAuthorized, Authorized, Declined
- 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
- one of: OnEstimate, InventoryReduced, None
- Description
- Name
motorApplicationId
- Type
- integer
- Description
- Name
pricing
- Type
- one of: FixedPrice, LineItem
- Description
- Name
fixedPriceCents
- Type
- integer
- Description
- the pre-tax cost of the service when pricing is FixedPrice
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
- 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
- one of: None, Completed, NotCompleted 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
completedAuthorizedLaborHours
- Type
- number Required
- Description
- Name
completedLaborHours
- Type
- number Required
- Description
- Name
totalAuthorizedLaborHours
- Type
- number Required
- Description
- Name
totalLaborHours
- Type
- number 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
allowCustomerViewInspections
- 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
status
- Type
- one of: Estimate, RepairOrder, Invoice Required
- Description
- Name
repairOrderDate
- Type
- string Required
- Description
- // the date the order was moved into repair order status
- 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
files
- Type
- array
- 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
locationIds
- Type
- array Required
- Description
- Name
customerType
- Type
- one of: Customer, Fleet 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
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
dotNumber
- Type
- string Required
- Description
- Name
paymentTermId
- Type
- string Required
- Description
- Name
publicId
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
marketingOptIn
- Type
- boolean Required
- Description
- Name
preferredContactMethod
- Type
- one of: SMS, Email, All Required
- Description
- Name
preferredLanguage
- Type
- one of: en, en_US, fr_CA 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
coalescedFirstNameOrCompanyName
- Type
- string Required
- Description
- 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
externalId
- Type
- string Required
- Description
- an id that can be used to reference the customer in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the customer
- Name
imported
- Type
- boolean 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
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- 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
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW 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
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
engines
- Type
- undefined Required
- Description
- an array of engines { id: string; make: string; model: string; hours: number; noHoursMeter: boolean; horsepower: number; serial: string; productionYear: number; productionMonth: number; }
- Name
engineHoursLogs
- Type
- undefined Required
- Description
- an array of engine hours logs { engineId: string; inHours: number; outHours: number; orderId: string; }
- 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
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example 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 Services
Add Service(s) to an Order
URL parameters
- Name
orderId
- Type
- string Required
- Description
- the id for the order
Body parameters
Consumes
The following content type is required: application/json
Array with the following properties:
- Name
fromCannedServiceId
- Type
- string Required
- Description
- the id for the service
- Name
ordinal
- Type
- number
- Description
- the desired ordinal for the service created from a canned service
- Name
fromDeferredServiceId
- Type
- string Required
- Description
- the id for the service
- Name
ordinal
- Type
- number
- Description
- the desired ordinal for the service created from a deferred 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
- one of: Percent, FixedCents
- Description
- Name
discountCents
- Type
- integer
- Description
- Name
discountPercent
- Type
- number
- Description
- Name
discountValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
taxCents
- Type
- integer
- Description
- Name
taxPercent
- Type
- number
- Description
- Name
taxValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
gstCents
- Type
- integer
- Description
- Name
gstPercent
- Type
- number
- Description
- Name
gstValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
pstCents
- Type
- integer
- Description
- Name
pstPercent
- Type
- number
- Description
- Name
pstValueType
- Type
- one of: Percent, FixedCents
- Description
- Name
hstCents
- Type
- integer
- Description
- Name
hstPercent
- Type
- number
- Description
- Name
hstValueType
- Type
- one of: Percent, FixedCents
- 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
- one of: NotAuthorized, Authorized, Declined
- 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
- one of: OnEstimate, InventoryReduced, None
- Description
- Name
motorApplicationId
- Type
- integer
- Description
- Name
pricing
- Type
- one of: FixedPrice, LineItem
- Description
- Name
fixedPriceCents
- Type
- integer
- Description
- the pre-tax cost of the service when pricing is FixedPrice
- 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
- Name
locationId
- Type
- string
- Description
- the id for the location
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
- Description
- Order schema
- Name
services
- Type
- array 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
- one of: None, Completed, NotCompleted 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
completedAuthorizedLaborHours
- Type
- number Required
- Description
- Name
completedLaborHours
- Type
- number Required
- Description
- Name
totalAuthorizedLaborHours
- Type
- number Required
- Description
- Name
totalLaborHours
- Type
- number 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
allowCustomerViewInspections
- 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
status
- Type
- one of: Estimate, RepairOrder, Invoice Required
- Description
- Name
repairOrderDate
- Type
- string Required
- Description
- // the date the order was moved into repair order status
- 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
files
- Type
- array
- 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
locationIds
- Type
- array Required
- Description
- Name
customerType
- Type
- one of: Customer, Fleet 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
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
dotNumber
- Type
- string Required
- Description
- Name
paymentTermId
- Type
- string Required
- Description
- Name
publicId
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
marketingOptIn
- Type
- boolean Required
- Description
- Name
preferredContactMethod
- Type
- one of: SMS, Email, All Required
- Description
- Name
preferredLanguage
- Type
- one of: en, en_US, fr_CA 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
coalescedFirstNameOrCompanyName
- Type
- string Required
- Description
- 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
externalId
- Type
- string Required
- Description
- an id that can be used to reference the customer in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the customer
- Name
imported
- Type
- boolean 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
locationIds
- Type
- array Required
- Description
- Name
baseId
- Type
- integer Required
- Description
- vcdb base id
- Name
size
- Type
- one of: HeavyDuty, LightDuty, Other Required
- Description
- Name
type
- Type
- one of: ATV, Bicycle, BigRig, Boat, ClassAMotorhome, ClassCMotorhome, Convertible, Coupe, FifthWheel, Hatchback, Jeep, Motorcycle, Other, PopUp, RV, SUV, Sedan, Trailer, TravelTrailer, Truck, TruckCamper, UTV, Van, Wagon Required
- Description
- Name
year
- Type
- integer Required
- Description
- Name
make
- Type
- string Required
- Description
- holds Hull make for vessel
- 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
engineId
- Type
- integer Required
- Description
- vcdb engine id
- Name
productionDate
- Type
- string Required
- Description
- Name
transmission
- Type
- one of: Automatic, Manual, AutomaticCVT, AutomaticDualClutch Required
- Description
- Name
transmissionId
- Type
- integer Required
- Description
- vcdb transmission id
- Name
transmissionSpeed
- Type
- string Required
- Description
- Name
transmissionMfrCode
- Type
- string Required
- Description
- Name
drivetrain
- Type
- one of: RWD, FWD, FourWD, AWD Required
- Description
- Name
drivetype
- Type
- string Required
- Description
- Name
drivetypeId
- Type
- integer Required
- Description
- vcdb drivetype id
- Name
bodyStyle
- Type
- string Required
- Description
- Name
bodyStyleId
- Type
- integer Required
- Description
- vcdb body style id
- Name
bedLength
- Type
- string Required
- Description
- Name
configurationStatus
- Type
- one of: Custom, Incomplete, Invalid, NotSupported, Valid Required
- Description
- Name
vin
- Type
- string Required
- Description
- Name
color
- Type
- one of: White, Silver, Gray, Black, Blue, Red, Brown, Burgundy, Tan, Gold, Green, Yellow, Orange, Pink, Purple, Other Required
- Description
- Name
unit
- Type
- string Required
- Description
- Name
mileage
- Type
- number Required
- Description
- Name
mileageUnit
- Type
- one of: Mile, Kilometer Required
- Description
- Name
odometer
- Type
- boolean Required
- Description
- Name
licensePlate
- Type
- string Required
- Description
- Name
licensePlateState
- Type
- string Required
- Description
- Name
licensePlateCountry
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW 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
externalId
- Type
- string Required
- Description
- an id that can be used to reference the vehicle in an external system
- Name
originLocationId
- Type
- string Required
- Description
- the location that created the vehicle
- Name
imported
- Type
- boolean Required
- Description
- Name
length
- Type
- number Required
- Description
- Name
lengthUnit
- Type
- one of: Ft, M Required
- Description
- Name
hin
- Type
- string Required
- Description
- Vessel hull identification number
- Name
serial
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Custom vehicle name / Vessel registered name
- Name
coalescedVINorHIN
- Type
- string Required
- Description
- Name
lastServicedDate
- Type
- string Required
- Description
- Name
frontTireSize
- Type
- string Required
- Description
- custom front tire size override value
- Name
rearTireSize
- Type
- string Required
- Description
- custom rear tire size override value
- Name
drivingCondition
- Type
- one of: Normal, Severe Required
- Description
- Name
engines
- Type
- undefined Required
- Description
- an array of engines { id: string; make: string; model: string; hours: number; noHoursMeter: boolean; horsepower: number; serial: string; productionYear: number; productionMonth: number; }
- Name
engineHoursLogs
- Type
- undefined Required
- Description
- an array of engine hours logs { engineId: string; inHours: number; outHours: number; orderId: string; }
- 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
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
POST
/v3/order/:orderId/servicecurl https://api.shopmonkey.cloud/v3/order/ORDERID/service \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H