Skip to main content
GET
/
v1
/
search
Global search
curl --request GET \
  --url http://localhost:3000/v1/search
{
  "products": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "scrapedProducts": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "orders": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "sweeps": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "staff": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "customers": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "retailers": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ],
  "locations": [
    {
      "id": "<string>",
      "type": "product",
      "title": "<string>",
      "subtitle": "<string>",
      "badge": "<string>",
      "badgeVariant": "<string>",
      "secondBadge": "<string>",
      "secondBadgeVariant": "<string>",
      "imageUrl": "<string>",
      "logoUrl": "<string>"
    }
  ]
}

Query Parameters

​
q
string
required

Search query

Required string length: 1 - 200
Example:

"john"

​
limit
integer
default:5

Max items per category

Required range: 1 <= x <= 20
Example:

5

Response

200 - application/json

Global search results

Global search response

​
products
object[]
required
​
scrapedProducts
object[]
required
​
orders
object[]
required
​
sweeps
object[]
required
​
staff
object[]
required
​
customers
object[]
required
​
retailers
object[]
required
​
locations
object[]
required