Customer
The Customer object is the key information about each of your customers created inside the Shopmonkey app. Each Customer is associated with the Location of the service.
You can set custom fields for a Customers by updating the custom field. Any data you place in the Customer object will be your responsibility. Shopmonkey will never mutate any values in this object. It is your responsibility to manage the data in this field.
Find Customer
Find one Customer by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object to retrieve
200
Response
- Name
data
- Type
- object Required
- Description
- Customer schema
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
labelConnections
- Type
- array Required
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON object
- Name
originLocationId
- Type
- string
- Description
- Location id by which customer was created(available in HQ or when data sharing is enabled)
- Name
connectedLocationIds
- Type
- array
- Description
Properties for meta
object
- Name
userId
- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId
- Type
- string
- Description
- the session id for the most recent change
- Name
version
- Type
- number
- Description
- a monotonically increasing number for the most recent change
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/customer/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",
"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,
"vehicleCount": 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
}
],
"labelConnections": [
{
"label": {
"id": "id",
"name": "name",
"color": "color",
"entity": "entity",
"saved": true
}
}
],
"customFields": {}
}
}
Update Customer
Update a Customer
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
Body parameters
- Name
firstName
- Type
- string
- Description
- Name
lastName
- Type
- string
- Description
- Name
companyName
- Type
- string
- Description
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string
- Description
- Name
state
- Type
- string
- Description
- Name
country
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
dotNumber
- Type
- string
- Description
- Name
paymentTermId
- Type
- string
- Description
- Name
note
- Type
- string
- Description
- Name
marketingOptIn
- Type
- boolean
- Description
- Name
preferredContactMethod
- Type
- string
- Description
- Name
referralSourceId
- Type
- string
- Description
- Name
taxExempt
- Type
- boolean
- Description
- US specific
- Name
gstExempt
- Type
- boolean
- Description
- CA specific
- Name
hstExempt
- Type
- boolean
- Description
- CA specific
- Name
pstExempt
- Type
- boolean
- Description
- CA specific
- Name
discountPercent
- Type
- number
- Description
- Name
laborRateId
- Type
- string
- Description
- Name
laborMatrixId
- Type
- string
- Description
- Name
pricingMatrixId
- Type
- string
- Description
- Name
fleetId
- Type
- string
- Description
- Name
customFields
- Type
- object
- Description
- custom field values
- Name
website
- Type
- string
- Description
- Name
finixIdentityId
- Type
- string
- Description
- Name
labels
- Type
- undefined
- 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
emails
- Type
- array
- Description
- Name
phoneNumbers
- 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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Import entities
Import one or more entities
Body parameters
- Name
entityType
- Type
- object
- Description
- Name
file
- Type
- undefined Required
- Description
- a multipart mime data payload in Microsoft Excel (xlsx) format
Properties for entityType
object
- Name
value
- Type
- string Required
- Description
- the entity name to import data to
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
added
- Type
- number Required
- Description
- number of records created
- Name
updated
- Type
- number Required
- Description
- number of records updated
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 Requestmultipart/form-data
curl https://api.shopmonkey.cloud/v3/customer/import \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: multipart/form-data' \
--data '{}'
Example Responseapplication/json
{}
Create Customer
Create a Customer
Body parameters
- Name
customerType
- Type
- string Required
- Description
- Name
firstName
- Type
- string
- Description
- Name
lastName
- Type
- string
- Description
- Name
companyName
- Type
- string
- Description
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string
- Description
- Name
state
- Type
- string
- Description
- Name
country
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
dotNumber
- Type
- string
- Description
- Name
paymentTermId
- Type
- string
- Description
- Name
note
- Type
- string
- Description
- Name
marketingOptIn
- Type
- boolean
- Description
- Name
preferredContactMethod
- Type
- string
- Description
- Name
referralSourceId
- Type
- string
- Description
- Name
taxExempt
- Type
- boolean
- Description
- US specific
- Name
gstExempt
- Type
- boolean
- Description
- CA specific
- Name
hstExempt
- Type
- boolean
- Description
- CA specific
- Name
pstExempt
- Type
- boolean
- Description
- CA specific
- Name
discountPercent
- Type
- number
- Description
- Name
laborRateId
- Type
- string
- Description
- Name
laborMatrixId
- Type
- string
- Description
- Name
pricingMatrixId
- Type
- string
- Description
- Name
fleetId
- Type
- string
- Description
- Name
customFields
- Type
- object
- Description
- custom field values
- Name
website
- Type
- string
- Description
- Name
finixIdentityId
- Type
- string
- Description
- Name
labels
- Type
- undefined
- 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
locationId
- Type
- string
- Description
- the location id
- Name
vehicleId
- Type
- string
- Description
- the vehicle id
- Name
emails
- Type
- array
- Description
- Name
phoneNumbers
- 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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "customerType" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Soft Delete Customer
Soft delete or undelete a Customer 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
- Customer schema
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
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
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
curl https://api.shopmonkey.cloud/v3/customer/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",
"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,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null
}
}
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
curl 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.433Z",
"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"
}
}
]
}
Create Email
Create a new email for the specified customer
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
email
- Type
- string Required
- Description
- Name
subscribed
- Type
- boolean
- Description
- Name
primary
- Type
- boolean
- Description
- Name
customerId
- Type
- string
- Description
- the customer id
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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID/email \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "email" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Update Email
Update the specified email for a customer
URL parameters
- Name
emailId
- Type
- string Required
- Description
- the email id
- Name
id
- Type
- string Required
- Description
- the id for the customer
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
email
- Type
- string
- Description
- Name
subscribed
- Type
- boolean
- Description
- Name
primary
- Type
- boolean
- 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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID/email/EMAILID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Delete Email
Delete the specified email for a customer
URL parameters
- Name
emailId
- Type
- string Required
- Description
- the email id
- Name
id
- Type
- string Required
- Description
- the id for the customer
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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID/email/EMAILID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Update Phone Number
Update the specified phone number for a customer
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
- Name
phoneNumberId
- Type
- string Required
- Description
- the phone id
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
number
- Type
- string
- Description
- Name
extension
- Type
- string
- Description
- Name
country
- Type
- string
- Description
- Name
type
- Type
- string
- Description
- Name
userDefinedType
- Type
- string
- Description
- Name
carrierName
- Type
- string
- Description
- Name
optInVerifiedDate
- Type
- string
- Description
- Name
optIn
- Type
- boolean
- Description
- Name
optInStatus
- Type
- string
- Description
- Name
lastVerifiedDate
- Type
- string
- Description
- Name
primary
- Type
- boolean
- Description
- Name
mobileCountryCode
- Type
- string
- Description
- if a mobile number, the mobile country code
- Name
mobileNetworkCode
- Type
- string
- Description
- if a mobile number, the mobile network code
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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID/phone_number/PHONENUMBERID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Delete Phone Number
Delete the specified phone number for a customer
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
- Name
phoneNumberId
- Type
- string Required
- Description
- the phone id
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
- Customer schema
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
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
emails
- Type
- array
- Description
- Name
phoneNumbers
- Type
- array
- Description
- Name
customFields
- Type
- object
- Description
- custom fields as JSON 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
curl https://api.shopmonkey.cloud/v3/customer/ID/phone_number/PHONENUMBERID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"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
}
],
"customFields": {}
}
}
Update Custom Fields
Update the custom fields for customer record
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
Body parameters
- Name
customFields
- Type
- object Required
- 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
curl https://api.shopmonkey.cloud/v3/customer/ID/customfield \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "customFields" : {} }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id"
}
}
Find Deferred Services
Find all deferred services by customer
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the customer
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean 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
curl https://api.shopmonkey.cloud/v3/customer/ID/deferred_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,
"order": {
"number": 1
},
"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"
}
}
]
}
]
}