/controller/dealers/search

POST /api/controller/dealers/search

Price: 20 credits

Search the Controller aircraft dealer directory by name, state, country, manufacturer or category: each dealer location with address, phone, logo and links to its inventory.

How to use it

Find aircraft dealers in a region or for a brand, then pass a dealer's company_id to controller/dealers/listings for its inventory.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string nullable — Dealer name to search for (minLength: 1)
• states array — US states or Canadian provinces, upper-case full names; several are OR-ed (default: [])
• countries array — Countries; several are OR-ed (default: []; one of: "Albania", "Argentina", "Armenia", "Australia", "Austria", "Belgium", "Bolivia", "Bosnia-Herzegovina", "Brazil", "Canada", "Chile", "China", "Colombia", "Costa Rica", "Croatia", "Cyprus", "Czech Republic", "Denmark", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Estonia", "Finland", "France", "Georgia", "Germany", "Ghana", "Greece", "Guatemala", "Guinea", "Guyana", "Honduras", "Hong Kong", "Hungary", "India", "Indonesia", "Ireland", "Israel", "Italy", "Jamaica", "Japan", "Jordan", "Kazakhstan", "Kenya", "Latvia", "Lithuania", "Luxembourg", "Macedonia", "Madagascar", "Malaysia", "Malta", "Mexico", "Monaco", "Mongolia", "Netherlands Antilles", "New Caledonia", "New Zealand", "Norway", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Poland", "Portugal", "Romania", "Saudi Arabia", "Serbia", "Singapore", "Slovakia", "Slovenia", "South Africa", "South Korea", "Spain", "Suriname", "Sweden", "Switzerland", "Taiwan", "Tanzania", "Thailand", "The Bahamas", "The Netherlands", "The Philippines", "Trinidad and Tobago", "Turkey", "USA", "United Arab Emirates", "United Kingdom", "Uruguay", "Zambia")
• manufacturers array — Manufacturers the dealer stocks, upper-case as the site spells them (default: [])
• category_ids array — Numeric category ids the dealer stocks (default: [])
• count integer required — Max number of dealers to return (min: 1; max: 500)

Response

• @type string (default: "ControllerDealer")
• id string required
• name string nullable
• branch_name string nullable
• address string nullable
• city_state_postal string nullable
• phone string nullable
• phone_e164 string nullable
• image string nullable
• company_id string nullable
• crm_id string nullable
• group_id string nullable
• inventory array (default: [])
  • @type string (default: "DealerInventoryLink")
  • name string nullable
  • url string required
• auctions array (default: [])
  • @type string (default: "DealerInventoryLink")
  • name string nullable
  • url string required

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 — The entity was not found, or a precondition failed 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.