Skip to main content
PATCH
/
serviceOrders
/
{id}
Updates a Service Order
curl --request PATCH \
  --url https://commerce.driv.ly/api/serviceOrders/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "type": [],
  "customer": [
    123
  ],
  "serviceQuotes": 123,
  "paymentLink": "<string>",
  "vin": 123,
  "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
  ]
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "type": [],
    "customer": [
      123
    ],
    "serviceQuotes": 123,
    "paymentLink": "<string>",
    "vin": 123,
    "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
    ]
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
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

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Service Order

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
type
enum<string>[] | null
Available options:
Condition Inspection,
Last Mile Delivery,
Long Haul Transport,
Mechanical Inspection,
Post Sale Inspection,
Pre-Paid Maintenance,
Pre-Purchase Inspection,
Safety Inspection,
Vehicle Service Contract,
Wash And Detail
​
customer
(number | Customer · object)[] | null
​
serviceQuotes
​
paymentLink
string | null
​
vin
​
status
enum<string> | null
Available options:
Quoted,
Pending,
In Review,
Active,
Dispatched,
En Route,
Complete,
Hold,
Cancel,
Error
​
error
string | null
​
orderId
string | null
​
price
string | null
​
rush
boolean | null
​
attachments
(number | Attachment · object)[] | null
​
quoteExpiration
string | null
​
ordered
string | null
​
start
string | null
​
due
string | null
​
consignor
​
billTo
​
origin
​
destination
​
deals
(number | Deal · object)[] | null
​
orderLink
string | null
​
tenant
(number | Tenant · object)[] | null

Response

ok

​
doc
ServiceOrder · object
required
​
message
string
required