GET
/
deals
curl --request GET \
  --url https://commerce.driv.ly/api/deals \
  --header 'Authorization: <api-key>'
{
  "docs": [
    {
      "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,
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "totalDocs": 123,
  "limit": 123,
  "totalPages": 123,
  "page": 123,
  "pagingCounter": 123,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 123,
  "nextPage": 123
}

Authorizations

​
Authorization
string
header
required

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
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

200 - application/json

ok

The response is of type object.