/bigbasket/search/suggestions

POST /api/bigbasket/search/suggestions

Price: 5 credits

Get BigBasket search autocomplete for a partial query: suggested brands, categories and up to 20 products with price, pack size and availability

How to use it

Set location to a pincode or area, or pass latitude and longitude, to get the products and prices of that delivery area; without either they are Bengaluru's.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string nullable — Delivery pincode or area name (examples: "400053", "Andheri West"; minLength: 2)
• latitude number nullable — Delivery latitude (examples: 19.1364016; min: -90; max: 90)
• longitude number nullable — Delivery longitude (examples: 72.8296252; min: -180; max: 180)
• query string required — Partial search query, at least 2 characters (examples: "bread", "ghe"; minLength: 2)

Response

• @type string (default: "BigbasketSuggestions")
• query string required
• message string nullable
• is_corrected boolean nullable
• brands array (default: [])
  • @type string (default: "BigbasketSuggestedLink")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • level integer nullable
• categories array (default: [])
  • @type string (default: "BigbasketSuggestedLink")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • level integer nullable
• products array (default: [])
  • @type string (default: "BigbasketProductCard")
  • id string required
  • url string nullable
  • name string nullable
  • brand string nullable
  • brand_alias string nullable
  • brand_url string nullable
  • unit string nullable
  • pack_description string nullable
  • currency string (default: "INR")
  • price number nullable
  • mrp number nullable
  • discount_label string nullable
  • is_available boolean nullable
  • availability_label string nullable
  • sales_label string nullable
  • image string nullable
  • images array (default: [])
  • highlights array (default: [])

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 — BigBasket does not deliver to that location, or no place matches it. 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.