Skip to main content
GET
/
serviceQuotes
/
{id}
Get a single Service Quote by its id
curl --request GET \
  --url https://commerce.driv.ly/api/serviceQuotes/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "type": [
    "Vehicle Service Contract"
  ],
  "status": "Quoted",
  "serviceProvider": [
    123
  ],
  "quoteId": "<string>",
  "partner": 123,
  "serviceOrders": "<string>",
  "checkoutLink": "<string>",
  "deal": 123,
  "vehicle": 123,
  "rush": true,
  "etaMin": "<string>",
  "etaMax": "<string>",
  "distance": 123,
  "expires": "<string>",
  "cost": "<string>",
  "price": "<string>",
  "margin": "<string>",
  "partnerProfitShare": "<string>",
  "partnerMargin": "<string>",
  "tenant": 123,
  "transportServiceOrders": "<string>",
  "transportServiceOrders2": [
    123
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { serviceQuotes } from '@drivly/commerce'

const sdk = new SDK(...)

const serviceQuotes = await sdk.serviceQuotes.findOne(serviceQuotesId: string): Promise<serviceQuotes>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Service Quote

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:
Vehicle Service Contract,
Pre-Paid Maintenance,
Long Haul Transport,
Last Mile Delivery,
Pre-Purchase Inspection,
Post Sale Inspection,
Condition Inspection,
Safety Inspection,
Mechanical Inspection,
Wash And Detail
​
status
enum<string> | null
Available options:
Quoted,
Pending,
In Review,
Active,
Dispatched,
En Route,
Complete,
Hold,
Cancel,
Error
​
serviceProvider
(number | Customer · object)[] | null
​
quoteId
string | null
​
partner
​
serviceOrders
string | null
​
checkoutLink
string | null
​
deal
​
vehicle
​
rush
boolean | null
​
etaMin
string | null
​
etaMax
string | null
​
distance
number | null
​
expires
string | null
​
cost
string | null
​
price
string | null
​
margin
string | null
​
partnerProfitShare
string | null
​
partnerMargin
string | null
​
tenant
​
transportServiceOrders
string | null
​
transportServiceOrders2
(number | ServiceOrder · object)[] | null