Skip to main content
GET
/
deals
/
{id}
Get a single Deal by its id
curl --request GET \
  --url https://commerce.driv.ly/api/deals/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "customer": 123,
  "vehicle": 123,
  "dealId": "<string>",
  "customerRelationship": "<string>",
  "coCustomer": 123,
  "companyConsumerCustomer": 123,
  "lienHolder": [
    123
  ],
  "dealer": 123,
  "facilitator": [
    123
  ],
  "type": [
    "Wholesale Dropship"
  ],
  "salesPrice": "<string>",
  "margin": "<string>",
  "downPayment": "<string>",
  "financedAmount": "<string>",
  "taxesAndFees": 123,
  "dependencies": [
    123
  ],
  "unsignedDocuments": "<string>",
  "signedDocuments": "<string>",
  "deliveryAddress": [
    123
  ],
  "paymentLink": "<string>",
  "getTradeOffer": "<string>",
  "notarizePowerOfAttorney": "<string>",
  "serviceQuotes": [
    123
  ],
  "tenant": 123,
  "trades": [
    123
  ],
  "creditApplications": [
    123
  ],
  "latestError": "<string>",
  "vscProvider": 123,
  "vsc": "<string>",
  "gapProvider": 123,
  "gap": "<string>",
  "status": "<string>",
  "transportServiceOrders": [
    123
  ],
  "mileage": 123,
  "createdBy": 123,
  "lastModifiedBy": 123,
  "development": true
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { deals } from '@drivly/commerce'

const sdk = new SDK(...)

const deals = await sdk.deals.findOne(dealsId: string): Promise<deals>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Deal

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
​
customer
​
vehicle
​
dealId
string | null
​
customerRelationship
string | null
​
coCustomer
​
companyConsumerCustomer
​
lienHolder
(number | Customer · object)[] | null
​
dealer
​
facilitator
(number | Customer · object)[] | null
​
type
enum<string>[] | null
Available options:
Wholesale Dropship,
Wholesale,
Concierge Search,
Consignment,
Instant Cash Offer,
Concierge Buy,
Private Party
​
salesPrice
string | null
​
margin
string | null
​
downPayment
string | null
​
financedAmount
string | null
​
taxesAndFees
​
dependencies
(number | Deal · object)[] | null
​
unsignedDocuments
string | null
​
signedDocuments
string | null
​
deliveryAddress
(number | Address · object)[] | null
​
paymentLink
string | null
​
getTradeOffer
string | null
​
notarizePowerOfAttorney
string | null
​
serviceQuotes
(number | ServiceQuote · object)[] | null
​
tenant
​
trades
(number | Trade · object)[] | null
​
creditApplications
(number | CreditApplication · object)[] | null
​
latestError
string | null
​
vscProvider
​
vsc
string | null
​
gapProvider
​
gap
string | null
​
status
string | null
​
transportServiceOrders
(number | ServiceOrder · object)[] | null
​
mileage
number | null
​
createdBy
number
​
lastModifiedBy
number
​
development
boolean | null