/iaai/branches

POST /api/iaai/branches

Price: 5 credits

Get one IAAI branch by id: address, phone, email, manager, office and yard hours, upcoming auction dates, payment and pickup terms, branch notes and the nearest other branches.

How to use it

Learn how to pay for and collect a vehicle won at an IAAI branch, and when its next sales run. Pass an upcoming auction date with the branch id to iaai/vehicles/search to list that sale.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• branch string required — IAAI branch id or an iaai.com branch URL (examples: "746", "https://www.iaai.com/Locations/746"; minLength: 1)

Response

• @type string (default: "IaaiBranch")
• id string required
• url string required
• name string nullable
• short_name string nullable
• location_id string nullable
• tenant string nullable
• address string nullable
• suite string nullable
• city string nullable
• state string nullable
• postal_code string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• fax string nullable
• email string nullable
• branch_manager string nullable
• branch_manager_email string nullable
• area_manager string nullable
• area_manager_email string nullable
• auction_access string nullable
• auction_schedule string nullable
• office_hours string nullable
• yard_hours string nullable
• onsite_preview string nullable
• additional_information string nullable
• branch_notes string nullable
• payment string nullable
• days_to_pay string nullable
• vehicle_pickup string nullable
• days_to_pick_up string nullable
• vehicle_count integer nullable
• next_auction_at integer nullable
• next_auction_id string nullable
• upcoming_auction_dates array (default: [])
• is_online_auction boolean nullable
• is_public_auction boolean nullable
• is_virtual boolean nullable
• image string nullable
• images array (default: [])
• nearby_branches array (default: [])
  • @type string (default: "IaaiNearbyBranch")
  • name string required
  • distance_miles integer nullable
• announcements array (default: [])
  • @type string (default: "IaaiBranchAnnouncement")
  • message string nullable
  • category string 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 IAAI branch with this id 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.