API Reference
- Addresses
- Attachments
- Calls
- Contacts
- Credit Applications
- Customers
- Deals
- Definitions
- DMV Fees
- Documents
- Fees
- Holidays
- Insurance Policies
- Insurance Quotes
- Leads
- Lead Events
- Listings
- Locations
- Logs
- Meetings
- Messages
- Pre-Approvals
- Sales Reps
- Searches
- Service Quotes
- Service Orders
- GETFind paginated Service Orders
- POSTCreate a new Service Order
- DELDelete multiple Service Orders
- PATCHUpdate multiple Service Orders
- GETGet a single Service Order by its id
- DELDeletes an existing Service Order
- PATCHUpdates a Service Order
- GETService Order versions
- GETGet a single Service Order version by its id
- POSTRestore a Service Order version by its id
- GET
- Taxes And Fees
- Templates
- CRM Trades
- Trades
- VDP Emails
- CRM Vehicles
- Vehicles
- Web Events
- Webhooks
Service Orders
Updates a Service Order
Updates a Service Order
PATCH
/
serviceOrders
/
{id}
Copy
curl --request PATCH \
--url https://commerce.driv.ly/api/serviceOrders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": [
"Condition Inspection"
],
"customer": [
123
],
"serviceQuotes": 123,
"paymentLink": "<string>",
"vin": 123,
"status": "Quoted",
"error": "<string>",
"orderId": "<string>",
"price": "<string>",
"rush": true,
"attachments": [
123
],
"quoteExpiration": "<string>",
"ordered": "<string>",
"start": "<string>",
"due": "<string>",
"consignor": 123,
"billTo": 123,
"origin": 123,
"destination": 123,
"deals": [
123
],
"orderLink": "<string>",
"tenant": [
123
],
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"name": "<string>",
"type": [
"Condition Inspection"
],
"customer": [
123
],
"serviceQuotes": 123,
"paymentLink": "<string>",
"vin": 123,
"status": "Quoted",
"error": "<string>",
"orderId": "<string>",
"price": "<string>",
"rush": true,
"attachments": [
123
],
"quoteExpiration": "<string>",
"ordered": "<string>",
"start": "<string>",
"due": "<string>",
"consignor": 123,
"billTo": 123,
"origin": 123,
"destination": 123,
"deals": [
123
],
"orderLink": "<string>",
"tenant": [
123
],
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Usage with the Drivly SDK
Usage with the Drivly SDK
Make sure you install our SDK first. You can find out how, and more here.
Copy
import { SDK } from '@drivly/commerce'
import type { serviceOrders } from '@drivly/commerce'
const sdk = new SDK(...)
const serviceOrders = await sdk.serviceOrders.update(serviceOrdersId: string, data: serviceOrders): Promise<serviceOrders>
Authorizations
Path Parameters
id of the Service Order
Query Parameters
number of levels to automatically populate relationships and uploads
retrieves document(s) in a specific locale
specifies a fallback locale if no locale value exists
Body
application/json
Response
200
application/json
ok
The response is of type object
.
Copy
curl --request PATCH \
--url https://commerce.driv.ly/api/serviceOrders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": [
"Condition Inspection"
],
"customer": [
123
],
"serviceQuotes": 123,
"paymentLink": "<string>",
"vin": 123,
"status": "Quoted",
"error": "<string>",
"orderId": "<string>",
"price": "<string>",
"rush": true,
"attachments": [
123
],
"quoteExpiration": "<string>",
"ordered": "<string>",
"start": "<string>",
"due": "<string>",
"consignor": 123,
"billTo": 123,
"origin": 123,
"destination": 123,
"deals": [
123
],
"orderLink": "<string>",
"tenant": [
123
],
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"name": "<string>",
"type": [
"Condition Inspection"
],
"customer": [
123
],
"serviceQuotes": 123,
"paymentLink": "<string>",
"vin": 123,
"status": "Quoted",
"error": "<string>",
"orderId": "<string>",
"price": "<string>",
"rush": true,
"attachments": [
123
],
"quoteExpiration": "<string>",
"ordered": "<string>",
"start": "<string>",
"due": "<string>",
"consignor": 123,
"billTo": 123,
"origin": 123,
"destination": 123,
"deals": [
123
],
"orderLink": "<string>",
"tenant": [
123
],
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.