Skip to main content
GET
/
serviceOrders
/
{id}
Get a single Service Order by its id
curl --request GET \
  --url https://commerce.driv.ly/api/serviceOrders/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "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
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.drivly.dev/llms.txt

Use this file to discover all available pages before exploring further.

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.findOne(serviceOrdersId: string): 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

​
sort
string

sort by field

​
where
Where clause · object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

ok

​
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