Skip to main content
PATCH
/
listings
Update multiple Listings
curl --request PATCH \
  --url https://commerce.driv.ly/api/listings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "vehicles": 123,
  "mileage": 123,
  "seller": "<string>",
  "wholesaleValue": "<string>",
  "wholesaleBuyNowPrice": "<string>",
  "wholesaleMinimumBid": "<string>",
  "wholesaleCurrentBid": "<string>",
  "wholesaleDetailPage": "<string>",
  "condition": 123,
  "wholesaleConditionReport": "<string>",
  "retailValue": "<string>",
  "retailAskingPrice": "<string>",
  "retailBuyNowPrice": "<string>",
  "vehicleHistoryReport": "<string>",
  "vehicleHistoryScore": "<string>",
  "cleanTitle": true,
  "owners": 123,
  "accidents": 123,
  "attachments": "<string>",
  "pickupLocation": 123,
  "tenant": 123
}
'
{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "vehicles": 123,
      "mileage": 123,
      "seller": "<string>",
      "wholesaleValue": "<string>",
      "wholesaleBuyNowPrice": "<string>",
      "wholesaleMinimumBid": "<string>",
      "wholesaleCurrentBid": "<string>",
      "wholesaleDetailPage": "<string>",
      "condition": 123,
      "wholesaleConditionReport": "<string>",
      "retailValue": "<string>",
      "retailAskingPrice": "<string>",
      "retailBuyNowPrice": "<string>",
      "vehicleHistoryReport": "<string>",
      "vehicleHistoryScore": "<string>",
      "cleanTitle": true,
      "owners": 123,
      "accidents": 123,
      "attachments": "<string>",
      "pickupLocation": 123,
      "tenant": 123
    }
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { listings } from '@drivly/commerce'

const sdk = new SDK(...)

const listings = await sdk.listings.unknown()

Authorizations

Authorization
string
header
required

Query Parameters

sort
string

sort by field

where
Where clause · object
required

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

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
vehicles
mileage
number | null
seller
string | null
wholesaleValue
string | null
wholesaleBuyNowPrice
string | null
wholesaleMinimumBid
string | null
wholesaleCurrentBid
string | null
wholesaleDetailPage
string | null
condition
number | null
wholesaleConditionReport
string | null
retailValue
string | null
retailAskingPrice
string | null
retailBuyNowPrice
string | null
vehicleHistoryReport
string | null
vehicleHistoryScore
string | null
cleanTitle
boolean | null
owners
number | null
accidents
number | null
attachments
string | null
pickupLocation
tenant

Response

200 - application/json

ok

message
string
errors
string[]
docs
Listing · object[]