/tractorsupply/products/search

POST /api/tractorsupply/products/search

Price: 60 credits

Search Tractor Supply products by keyword with regional price, store stock, rating and filters by brand, rating and any listing attribute

How to use it

Search the Tractor Supply catalogue by keyword; a keyword Tractor Supply sends to a category returns that category's products. Pass zip_code to get the price and stock of the nearest store; without it each product carries the lowest and highest regional price.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• zip_code string nullable — US ZIP code; the nearest Tractor Supply store sets price and stock (examples: "08085")
• count integer required — Max number of products to return (min: 1; max: 5000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "rating", "name_a_to_z", "name_z_to_a", "price_low_to_high", "price_high_to_low")
• brands array nullable — Brand names (examples: ["Retriever"], ["Retriever","4health"])
• min_rating integer nullable — Minimum average star rating (min: 1; max: 5)
• in_stock_at_store boolean — Only products in stock at the store nearest to zip_code (default: false)
• attributes object nullable — Other filters as shown on Tractor Supply listings: filter name to accepted values (examples: {"Pet Life Stage":["Puppy"]}, {"TempBreedSize":["Large"]})
  • * array
• query string required — Search keywords (examples: "dog food", "chicken feed", "t-post"; minLength: 1)

Response

• @type string (default: "TractorsupplyProduct")
• id string required
• name string nullable
• url string nullable
• image string nullable
• brand string nullable
• manufacturer string nullable
• manufacturer_part_number string nullable
• catalog_entry_id string nullable
• selected_variant_id string nullable
• price number nullable
• price_min number nullable
• price_max number nullable
• currency string nullable
• list_price number nullable
• savings number nullable
• price_type string nullable
• map_price number nullable
• map_list_price number nullable
• map_policy string nullable
• store_id string nullable
• price_zone string nullable
• is_in_stock_at_store boolean nullable
• is_in_transit_to_store boolean nullable
• rating number nullable
• review_count integer nullable
• availability string nullable
• shipping_message string nullable
• country_of_origin string nullable
• color string nullable
• color_family string nullable
• description string nullable
• badges array (default: [])
• category_ids array (default: [])
• is_buyable boolean nullable
• is_prescription boolean nullable
• is_pickup_allowed boolean nullable
• is_same_day_delivery_eligible boolean nullable
• is_standard_delivery_eligible boolean nullable
• is_parcel_delivery_from_store_eligible boolean nullable
• is_subscribable boolean nullable
• is_hazmat boolean nullable
• is_truck_delivery boolean nullable
• promotions array (default: [])
  • @type string (default: "TractorsupplyPromotion")
  • id string nullable
  • message string required
  • discount_type string nullable
  • discount_value number nullable
  • max_discount number nullable
  • is_subscription boolean nullable
  • fulfillment_types array (default: [])
• options array (default: [])
  • @type string (default: "TractorsupplyAttribute")
  • name string required
  • value string required
• attributes array (default: [])
  • @type string (default: "TractorsupplyAttribute")
  • name string required
  • value string required
• attachments array (default: [])
  • @type string (default: "TractorsupplyAttachment")
  • name string nullable
  • url string required
• variants array (default: [])
  • @type string (default: "TractorsupplyVariant")
  • id string required
  • catalog_entry_id string nullable
  • manufacturer_part_number string nullable
  • upc string nullable
  • url string nullable
  • image string nullable
  • color string nullable
  • availability string nullable
  • options array (default: [])
    • @type string (default: "TractorsupplyAttribute")
    • name string required
    • value string required
  • price number nullable
  • list_price number nullable
  • savings number nullable
  • price_type string nullable
  • map_price number nullable
  • map_list_price number nullable
  • promotions array (default: [])
    • @type string (default: "TractorsupplyPromotion")
    • id string nullable
    • message string required
    • discount_type string nullable
    • discount_value number nullable
    • max_discount number nullable
    • is_subscription boolean nullable
    • fulfillment_types array (default: [])
  • attributes array (default: [])
    • @type string (default: "TractorsupplyAttribute")
    • name string required
    • value string required

Errors

• 422 — The ZIP code has no nearby store, or a filter name or value does not apply to the results. 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.