/iaai/vehicles

POST /api/iaai/vehicles

Price: 10 credits

Get one IAAI vehicle by item id: full specs, title and sale document, damage and loss type, odometer, start code, auction date with lane and run, branch, bidding terms and the photo set.

How to use it

Check a salvage vehicle's title document, damage, keys and run-and-drive status before an IAAI auction. Pass an id from iaai/vehicles/search; branch_id resolves in iaai/branches.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• vehicle string required — IAAI item id with tenant (46298439~US), a bare item id, or an iaai.com vehicle URL (examples: "46298439~US", "https://www.iaai.com/VehicleDetail/46298439~US"; minLength: 1)

Response

• @type string (default: "IaaiVehicleDetail")
• id string required
• tenant string required
• url string required
• stock_number string nullable
• year integer nullable
• make string nullable
• model string nullable
• series string nullable
• vin_masked string nullable
• vin_status string nullable
• inventory_type string nullable
• inventory_category string nullable
• inventory_status string nullable
• vehicle_class string nullable
• segment string nullable
• body_style string nullable
• engine string nullable
• displacement string nullable
• cylinders string nullable
• fuel_type string nullable
• transmission string nullable
• drive_line_type string nullable
• exterior_color string nullable
• interior_color string nullable
• country_of_origin string nullable
• restraint_system string nullable
• options string nullable
• catalytic_converter string nullable
• navigation string nullable
• odometer integer nullable
• odometer_brand string nullable
• odometer_unit string nullable
• start_code string nullable
• start_code_label string nullable
• airbags string nullable
• has_keys boolean nullable
• has_key_fob boolean nullable
• is_run_and_drive boolean nullable
• is_operable boolean nullable
• is_hybrid boolean nullable
• primary_damage string nullable
• primary_damage_code string nullable
• secondary_damage string nullable
• loss_type string nullable
• loss_type_code string nullable
• title_code string nullable
• title_sale_doc string nullable
• title_state string nullable
• title_state_name string nullable
• title_notes string nullable
• who_can_buy array (default: [])
• provider_type string nullable
• origin string nullable
• seller string nullable
• market string nullable
• currency string nullable
• actual_cash_value number nullable
• estimated_repair_cost number nullable
• minimum_bid number nullable
• buy_now_price number nullable
• bid_increment number nullable
• prebid_activity string nullable
• bidding_notes array (default: [])
• is_public_auction boolean nullable
• is_timed_auction boolean nullable
• is_cat_vehicle boolean nullable
• auction_at integer nullable
• auction_schedule_id string nullable
• lane string nullable
• run_number string nullable
• aisle string nullable
• stall string nullable
• vehicle_location string nullable
• branch_id string nullable
• branch_name string nullable
• branch_address string nullable
• branch_city string nullable
• branch_state string nullable
• branch_postal_code string nullable
• branch_phone string nullable
• latitude number nullable
• longitude number nullable
• created_at integer nullable
• updated_at integer nullable
• image_360_url string nullable
• images array (default: [])
  • @type string (default: "IaaiVehicleImage")
  • url string required
  • sequence integer nullable
  • width integer nullable
  • height integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No vehicle with this item id is listed on IAAI Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.