Setup Dealership

Setup Dealer

curl --request POST \
  --url https://api.autosnap.com/v1/dealers/setup \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "dealership_url": "<string>",
  "dealer_name": "<string>",
  "city": "<string>",
  "state": "<string>",
  "street_address": "<string>",
  "phone_number": "<string>",
  "async_mode": false
}
'

import requests

url = "https://api.autosnap.com/v1/dealers/setup"

payload = {
    "api_key": "<string>",
    "dealership_url": "<string>",
    "dealer_name": "<string>",
    "city": "<string>",
    "state": "<string>",
    "street_address": "<string>",
    "phone_number": "<string>",
    "async_mode": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    api_key: '<string>',
    dealership_url: '<string>',
    dealer_name: '<string>',
    city: '<string>',
    state: '<string>',
    street_address: '<string>',
    phone_number: '<string>',
    async_mode: false
  })
};

fetch('https://api.autosnap.com/v1/dealers/setup', 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://api.autosnap.com/v1/dealers/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>',
    'dealership_url' => '<string>',
    'dealer_name' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'street_address' => '<string>',
    'phone_number' => '<string>',
    'async_mode' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.autosnap.com/v1/dealers/setup"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}")

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

	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.post("https://api.autosnap.com/v1/dealers/setup")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.autosnap.com/v1/dealers/setup")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

dealers

setup

Setup Dealer

curl --request POST \
  --url https://api.autosnap.com/v1/dealers/setup \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "dealership_url": "<string>",
  "dealer_name": "<string>",
  "city": "<string>",
  "state": "<string>",
  "street_address": "<string>",
  "phone_number": "<string>",
  "async_mode": false
}
'

import requests

url = "https://api.autosnap.com/v1/dealers/setup"

payload = {
    "api_key": "<string>",
    "dealership_url": "<string>",
    "dealer_name": "<string>",
    "city": "<string>",
    "state": "<string>",
    "street_address": "<string>",
    "phone_number": "<string>",
    "async_mode": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    api_key: '<string>',
    dealership_url: '<string>',
    dealer_name: '<string>',
    city: '<string>',
    state: '<string>',
    street_address: '<string>',
    phone_number: '<string>',
    async_mode: false
  })
};

fetch('https://api.autosnap.com/v1/dealers/setup', 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://api.autosnap.com/v1/dealers/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>',
    'dealership_url' => '<string>',
    'dealer_name' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'street_address' => '<string>',
    'phone_number' => '<string>',
    'async_mode' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.autosnap.com/v1/dealers/setup"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}")

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

	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.post("https://api.autosnap.com/v1/dealers/setup")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.autosnap.com/v1/dealers/setup")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\",\n  \"dealership_url\": \"<string>\",\n  \"dealer_name\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"async_mode\": false\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST /v1/dealers/setup

v1.0 schema lock. The response shape on this page is the locked v1.0 contract. We will never remove a documented field, never rename a field, and never change a field’s type without bumping to v2 (see Versioning). New fields may be added additively; your client must tolerate unknown keys. This endpoint has two distinct success-response variants: async job creation (HTTP 202 — the standard flow) and reactivation (HTTP 200 — when an inactive subscription exists for the URL).

Onboard a new dealership. Detects the website provider, generates the configuration, creates the subscription, and triggers the first inventory import. If the dealership was previously deleted (subscription deactivated), calling setup again will reactivate the existing subscription instead of creating a duplicate.

How It Works

POST this endpoint. You get back HTTP 202 with a setup_id in well under a second.
The setup job (provider detection, AI config validation, subscription creation) runs in the background — typically 60 seconds, up to ~10 minutes for heavily bot-protected sites.
Poll GET /v1/dealers/setup/{setup_id} until status is "completed" or "failed". Recommended polling interval: 5 seconds.
Or skip polling: subscribe to the setup.complete webhook before calling setup.

Request Body

Field	Type	Required	Default	Description
`api_key`	string	Yes	—	Your API key. Accepted in body (canonical) or `?api_key=…` query string.
`dealership_url`	string	Yes	—	The dealership’s website URL (e.g. `https://www.baydodge.net`)
`dealer_name`	string	No	—	Override the detected dealer name
`city`	string	No	—	Dealer city (used if auto-detection can’t determine location)
`state`	string	No	—	Dealer state
`street_address`	string	No	—	Dealer street address
`phone_number`	string	No	—	Dealer phone number
`condition_filter`	string	No	`null`	Filter inventory by condition. Values: `"new"`, `"used"`, or `null` (all conditions). When set, only vehicles matching this condition are included in imports for this subscription.
`async_mode`	boolean	No	—	Deprecated, ignored. Setup is always asynchronous. The field is tolerated for backward compatibility.

Example

curl -X POST "https://api.autosnap.com/v1/dealers/setup" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "YOUR_API_KEY",
    "dealership_url": "https://www.baydodge.net"
  }'

Response — HTTP 202 Accepted

{
  "success": true,
  "setup_id": "setup_6420ad759b71",
  "status": "pending",
  "message": "Setup job created. Poll GET /v1/dealers/setup/{setup_id} for status, or wait for the setup.complete webhook.",
  "poll_url": "/v1/dealers/setup/setup_6420ad759b71"
}

Poll for completion (every 5 seconds):

curl "https://api.autosnap.com/v1/dealers/setup/setup_6420ad759b71?api_key=YOUR_API_KEY"

See Get Setup Status for the full response shape of every status value (pending, running, completed, failed). When status is "completed", the poll response carries the detected provider, provider_confidence, config, vehicle_counts, and the new dealership_id / configuration_id / subscription_id. setup_status on the completed poll response is "active" when detection and validation both pass. If detection succeeds but the test scrape has issues (e.g. missing critical fields), the status is "needs_manual_review" — imports are still created but may need attention, and the poll response includes a human-readable requires_review_reason.

status: "completed" means detection and configuration are done — NOT that inventory is available. Poll until inventory_status: "available", or subscribe to the import.complete webhook. See Get Setup Status for details.

Inventory is automatically refreshed every 12 hours. This is the default schedule for all new dealerships and is not configurable via the API.

Reactivation

If you previously deleted a dealership and call setup again with the same URL, the existing subscription is reactivated. This completes inline (no detection runs) and returns HTTP 200:

{
  "success": true,
  "reactivated": true,
  "subscription_id": 221,
  "configuration_id": 9,
  "website_url": "baydodge.net",
  "message": "Dealership subscription reactivated"
}

Errors

Status	Description
409	Dealership is already actively subscribed under your account
422	Request body failed validation (e.g. missing `dealership_url`)
503	Setup queue unavailable — the job could not be enqueued. Safe to retry.

Detection failures (e.g. the website provider could not be identified) no longer surface as POST errors — the POST succeeds with 202, and the failure is reported on the poll response as status: "failed" with an error message and, when available, a failure_mode classification.

Body

application/json

api_key

string

required

dealership_url

string

required

dealer_name

string | null

city

string | null

state

string | null

street_address

string | null

phone_number

string | null

async_mode

boolean | null

default:false

Response

Successful Response

Resolve Dealership Get Setup Status

API Reference

Dealers

Inventory

Semantic Search

Feed Management

Webhooks

Account

How It Works

Request Body

Example

Response — HTTP 202 Accepted

Reactivation

Errors

Body

Response

​How It Works

​Request Body

​Example

​Response — HTTP 202 Accepted

​Reactivation

​Errors

Body

Response

How It Works

Request Body

Example

Response — HTTP 202 Accepted

Reactivation

Errors