Get Advanced Business Search Results
API operation: Open the endpoint in Scalar
Use GET /search to retrieve advanced business search results. The operation is Search.search.
This operation does not require authentication. order_type_id and JSON location are required; location must include numeric lat and lng. An optional term must contain at least two characters.
See Advanced business search model.
OpenAPI reference
Operation: GET /search
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
orderBy | string | No | Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas. |
where | string | No | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension. |
page | integer | No | Page number, starting at 1. Applies only to lists that return a pagination block. |
page_size | integer | No | Number of items per page. |
order_type_id | integer | Yes | — |
location | string | Yes | — |
term | string | No | — |
tags | array<integer> | No | — |
max_distance | number | No | — |
max_eta | integer | No | — |
max_delivery_price | number | No | — |
max_product_price | number | No | — |
featured_products | boolean | No | — |
in_offer_products | boolean | No | — |
level_price | string | No | — |
fuzzy | boolean | No | — |
fuzzy_threshold | number | No | — |
business_types | string | No | — |
closed_businesses | string | No | — |
debug_timing | boolean | No | — |
excludes | string | No | — |
forceOrderBy | string | No | — |
force_lazy_load_products | boolean | No | — |
force_max_distance | string | No | — |
franchise_ids | string | No | — |
geo_dz_first | boolean | No | — |
limit | integer | No | — |
price_level | integer | No | — |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized (ProjectAccessErrorResponse) |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |