Update multiple Searches

curl --request PATCH \
  --url https://commerce.driv.ly/api/searches \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "lead": 123,
  "retailListingUrls": "<string>",
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "bodyStyle": [],
  "drive": [],
  "transmission": [],
  "maxPrice": "<string>",
  "maxMiles": 123,
  "newOrUsed": [],
  "minimumGrade": 123,
  "requiredOptions": [],
  "acceptableColors": [],
  "acceptableInterior": [],
  "proposedVehicles": "<string>",
  "vehicles": [
    123
  ],
  "lastModifiedBy": 123,
  "seats": "<string>",
  "updateRequested": "<string>",
  "oneOwner": true,
  "priority": true
}
'

import requests

url = "https://commerce.driv.ly/api/searches"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "lead": 123,
    "retailListingUrls": "<string>",
    "year": "<string>",
    "make": "<string>",
    "model": "<string>",
    "trim": "<string>",
    "bodyStyle": [],
    "drive": [],
    "transmission": [],
    "maxPrice": "<string>",
    "maxMiles": 123,
    "newOrUsed": [],
    "minimumGrade": 123,
    "requiredOptions": [],
    "acceptableColors": [],
    "acceptableInterior": [],
    "proposedVehicles": "<string>",
    "vehicles": [123],
    "lastModifiedBy": 123,
    "seats": "<string>",
    "updateRequested": "<string>",
    "oneOwner": True,
    "priority": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    lead: 123,
    retailListingUrls: '<string>',
    year: '<string>',
    make: '<string>',
    model: '<string>',
    trim: '<string>',
    bodyStyle: [],
    drive: [],
    transmission: [],
    maxPrice: '<string>',
    maxMiles: 123,
    newOrUsed: [],
    minimumGrade: 123,
    requiredOptions: [],
    acceptableColors: [],
    acceptableInterior: [],
    proposedVehicles: '<string>',
    vehicles: [123],
    lastModifiedBy: 123,
    seats: '<string>',
    updateRequested: '<string>',
    oneOwner: true,
    priority: true
  })
};

fetch('https://commerce.driv.ly/api/searches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce.driv.ly/api/searches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'lead' => 123,
    'retailListingUrls' => '<string>',
    'year' => '<string>',
    'make' => '<string>',
    'model' => '<string>',
    'trim' => '<string>',
    'bodyStyle' => [
        
    ],
    'drive' => [
        
    ],
    'transmission' => [
        
    ],
    'maxPrice' => '<string>',
    'maxMiles' => 123,
    'newOrUsed' => [
        
    ],
    'minimumGrade' => 123,
    'requiredOptions' => [
        
    ],
    'acceptableColors' => [
        
    ],
    'acceptableInterior' => [
        
    ],
    'proposedVehicles' => '<string>',
    'vehicles' => [
        123
    ],
    'lastModifiedBy' => 123,
    'seats' => '<string>',
    'updateRequested' => '<string>',
    'oneOwner' => true,
    'priority' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://commerce.driv.ly/api/searches"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://commerce.driv.ly/api/searches")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/searches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "lead": 123,
      "retailListingUrls": "<string>",
      "year": "<string>",
      "make": "<string>",
      "model": "<string>",
      "trim": "<string>",
      "bodyStyle": [],
      "drive": [],
      "transmission": [],
      "maxPrice": "<string>",
      "maxMiles": 123,
      "newOrUsed": [],
      "minimumGrade": 123,
      "requiredOptions": [],
      "acceptableColors": [],
      "acceptableInterior": [],
      "proposedVehicles": "<string>",
      "vehicles": [
        123
      ],
      "lastModifiedBy": 123,
      "seats": "<string>",
      "updateRequested": "<string>",
      "oneOwner": true,
      "priority": true
    }
  ]
}

PATCH

searches

Update multiple Searches

curl --request PATCH \
  --url https://commerce.driv.ly/api/searches \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "lead": 123,
  "retailListingUrls": "<string>",
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "bodyStyle": [],
  "drive": [],
  "transmission": [],
  "maxPrice": "<string>",
  "maxMiles": 123,
  "newOrUsed": [],
  "minimumGrade": 123,
  "requiredOptions": [],
  "acceptableColors": [],
  "acceptableInterior": [],
  "proposedVehicles": "<string>",
  "vehicles": [
    123
  ],
  "lastModifiedBy": 123,
  "seats": "<string>",
  "updateRequested": "<string>",
  "oneOwner": true,
  "priority": true
}
'

import requests

url = "https://commerce.driv.ly/api/searches"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "lead": 123,
    "retailListingUrls": "<string>",
    "year": "<string>",
    "make": "<string>",
    "model": "<string>",
    "trim": "<string>",
    "bodyStyle": [],
    "drive": [],
    "transmission": [],
    "maxPrice": "<string>",
    "maxMiles": 123,
    "newOrUsed": [],
    "minimumGrade": 123,
    "requiredOptions": [],
    "acceptableColors": [],
    "acceptableInterior": [],
    "proposedVehicles": "<string>",
    "vehicles": [123],
    "lastModifiedBy": 123,
    "seats": "<string>",
    "updateRequested": "<string>",
    "oneOwner": True,
    "priority": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    lead: 123,
    retailListingUrls: '<string>',
    year: '<string>',
    make: '<string>',
    model: '<string>',
    trim: '<string>',
    bodyStyle: [],
    drive: [],
    transmission: [],
    maxPrice: '<string>',
    maxMiles: 123,
    newOrUsed: [],
    minimumGrade: 123,
    requiredOptions: [],
    acceptableColors: [],
    acceptableInterior: [],
    proposedVehicles: '<string>',
    vehicles: [123],
    lastModifiedBy: 123,
    seats: '<string>',
    updateRequested: '<string>',
    oneOwner: true,
    priority: true
  })
};

fetch('https://commerce.driv.ly/api/searches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce.driv.ly/api/searches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'lead' => 123,
    'retailListingUrls' => '<string>',
    'year' => '<string>',
    'make' => '<string>',
    'model' => '<string>',
    'trim' => '<string>',
    'bodyStyle' => [
        
    ],
    'drive' => [
        
    ],
    'transmission' => [
        
    ],
    'maxPrice' => '<string>',
    'maxMiles' => 123,
    'newOrUsed' => [
        
    ],
    'minimumGrade' => 123,
    'requiredOptions' => [
        
    ],
    'acceptableColors' => [
        
    ],
    'acceptableInterior' => [
        
    ],
    'proposedVehicles' => '<string>',
    'vehicles' => [
        123
    ],
    'lastModifiedBy' => 123,
    'seats' => '<string>',
    'updateRequested' => '<string>',
    'oneOwner' => true,
    'priority' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://commerce.driv.ly/api/searches"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://commerce.driv.ly/api/searches")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/searches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"retailListingUrls\": \"<string>\",\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"bodyStyle\": [],\n  \"drive\": [],\n  \"transmission\": [],\n  \"maxPrice\": \"<string>\",\n  \"maxMiles\": 123,\n  \"newOrUsed\": [],\n  \"minimumGrade\": 123,\n  \"requiredOptions\": [],\n  \"acceptableColors\": [],\n  \"acceptableInterior\": [],\n  \"proposedVehicles\": \"<string>\",\n  \"vehicles\": [\n    123\n  ],\n  \"lastModifiedBy\": 123,\n  \"seats\": \"<string>\",\n  \"updateRequested\": \"<string>\",\n  \"oneOwner\": true,\n  \"priority\": true\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "lead": 123,
      "retailListingUrls": "<string>",
      "year": "<string>",
      "make": "<string>",
      "model": "<string>",
      "trim": "<string>",
      "bodyStyle": [],
      "drive": [],
      "transmission": [],
      "maxPrice": "<string>",
      "maxMiles": 123,
      "newOrUsed": [],
      "minimumGrade": 123,
      "requiredOptions": [],
      "acceptableColors": [],
      "acceptableInterior": [],
      "proposedVehicles": "<string>",
      "vehicles": [
        123
      ],
      "lastModifiedBy": 123,
      "seats": "<string>",
      "updateRequested": "<string>",
      "oneOwner": true,
      "priority": true
    }
  ]
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { searches } from '@drivly/commerce'

const sdk = new SDK(...)

const searches = await sdk.searches.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)

Show child attributes

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

lead

status

enum<string> | null

Available options:

On Hold,

Searching,

Results Found,

Search Cancelled

retailListingUrls

string | null

year

string | null

make

string | null

model

string | null

trim

string | null

bodyStyle

enum<string>[] | null

Available options:

car,

suv,

truck,

van,

wagon

drive

enum<string>[] | null

Available options:

4WD,

AWD,

2WD

transmission

enum<string>[] | null

Available options:

Manual,

Automatic

maxPrice

string | null

maxMiles

number | null

newOrUsed

enum<string>[] | null

Available options:

New,

Certified,

Used

minimumGrade

number | null

requiredOptions

enum<string>[] | null

Available options:

Heated Seats,

No crazy colors,

Tow package,

Heated wheel,

Panoramic sunroof,

Leather Seats,

Bluetooth,

Backup Camera,

Apple Play,

Cooled Seats

acceptableColors

enum<string>[] | null

Available options:

Anti-Black,

Anti-Gray,

Anti-Red,

Anti-Silver,

Anti-White,

Beige,

Black,

Blue,

Brown,

Gold,

Gray,

Green,

Light Blue,

Orange,

Red,

Silver,

White,

Yellow

acceptableInterior

enum<string>[] | null

Available options:

Beige,

Black,

Brown,

Cream,

Gray,

Ivory,

Red,

Tan,

White,

Blue,

Burgundy,

Charcoal,

Off-White

proposedVehicles

string | null

vehicles

(number | Vehicle · object)[] | null

lastModifiedBy

number

seats

string | null

updateRequested

string | null

oneOwner

boolean | null

priority

boolean | null

Response

200 - application/json

message

string

errors

string[]

docs

Search · object[]

Show child attributes

Commerce

API Reference

Update multiple Searches

Authorizations

Query Parameters

Body

Response