/truckpaper/dealers/listings

POST /api/truckpaper/dealers/listings

Price: 20 credits

List the trucks and trailers a TruckPaper dealer location has for sale, with asking price, specs and photos.

How to use it

Pull one dealer's current inventory after finding the dealer with truckpaper/dealers/search. An empty list comes back both for a dealer with no live listings and for an unknown dealer id; the source answers the two identically, so an empty list does not confirm the id exists.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dealer_id string required — Dealer id from truckpaper/dealers/search (examples: "350007278500"; pattern: ^\d+$)
• count integer required — Max number of listings to return (min: 1; max: 9996)
• sort string — Result ordering (default: "best_match"; one of: "best_match", "price_low_to_high", "price_high_to_low", "year_old_to_new", "year_new_to_old", "mileage_low_to_high", "mileage_high_to_low", "recently_added", "recently_updated", "manufacturer", "model", "stock_number")

Response

• @type string (default: "TruckpaperListingCard")
• id string required
• url string nullable
• year integer nullable
• manufacturer string nullable
• model string nullable
• condition string nullable
• listing_type string nullable
• category_id string nullable
• category string nullable
• price number nullable
• price_text string nullable
• price_label string nullable
• price_options array (default: [])
  • @type string (default: "ListingPriceOption")
  • group string nullable
  • name string nullable
  • price_text string required
• currency string nullable
• serial_number string nullable
• description string nullable
• updated_at integer nullable
• image string nullable
• images array (default: [])
• image_count integer nullable
• video_count integer nullable
• is_featured boolean nullable
• is_premium boolean nullable
• external_id string nullable
• seller object nullable
  • @type string (default: "ListingSeller")
  • name string nullable
  • parent_account_name string nullable
  • address string nullable
  • contact_name string nullable
  • phone string nullable
  • phone_e164 string nullable
  • website_url string nullable
  • dealer_id string nullable
  • company_id string nullable
  • crm_id string nullable
  • group_id string nullable
• location object nullable
  • @type string (default: "ListingLocation")
  • address string nullable
  • street string nullable
  • city string nullable
  • state string nullable
  • country string nullable
  • postal_code string nullable
  • latitude number nullable
  • longitude number nullable
• specs array (default: [])
  • @type string (default: "ListingSpec")
  • group string nullable
  • name string required
  • value 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.