Get items by searching

Retrieve a list of items based on a search query. This endpoint allows you to search for items using keywords and returns a paginated list of matching items.

Requirements

• query is required.
• type is required.
• Pagination is supported via page and limit.

Usage

Request

• Method: GET
• Path: /v1/global-search

Query Parameters

| Name | Type | Required | Example | Description | |------|--------|----------|---------|-------------| | query | string | Yes | example | Search keyword(s). | | type | string | Yes | PRODUCT | Item type to search. | | page | number | No | 1 | Page number (starting from 1). | | limit | number | No | 20 | Number of items per page. |

Example

curl -X GET "https://api.example.com/v1/global-search?query=example&type=PRODUCT&page=1&limit=20"

Response

200 OK

Returns a standard API envelope with pagination, search results, and aggregations for building filters.

Example:

{
  "status": true,
  "path": "/v1/global-search?query=example&type=PRODUCT&page=1&limit=20",
  "statusCode": 200,
  "message": "Success",
  "data": {
    "current_page": "1",
    "last_page": 1,
    "total_count": 1,
    "per_page": "20",
    "total_pages": 1,
    "items": [
      {
        "is_onsale": false,
        "id": "15bafde3-a9fd-4079-be05-da66daa398b1",
        "product_name": "Example Multipurpose Shopify Theme",
        "slug": "example-multipurpose-shopify-theme",
        "mrp": 54,
        "campaign_start_date": null,
        "campaign_end_date": null,
        "image": "public/PRODUCT/1749013336290.png",
        "price": 54,
        "primary_category": {
          "id": 336,
          "name": "eCommerce",
          "slug": "ecommerce-7"
        },
        "secondary_category": {
          "id": 345,
          "name": "Fashion",
          "slug": "fashion_2"
        },
        "short_description": "example is a multipurpose Shopify theme that offers powerful and advanced features and options backed by stunning design. It’s an all-in-one solution that can be used for online stores across various industries.",
        "avg_rating": "5.00",
        "total_reviews": 0,
        "total_sales": 2,
        "updated_at": "2026-03-01T00:40:09.287Z",
        "is_liked": false,
        "user": {
          "sub": "89887e51-073f-49d3-a19b-4ee9c1bd7c5b",
          "first_name": "Easital",
          "last_name": "Theme",
          "user_name": "EasitalTheme",
          "email": "",
          "profile_image": "manobai/Avatar/89887e51-073f-49d3-a19b-4ee9c1bd7c5b/1770281102268.jpg"
        }
      }
    ],
    "aggregations": {
      "categories": [
        {
          "id": 336,
          "name": "eCommerce",
          "slug": "ecommerce-7",
          "item_count": 1
        }
      ],
      "pricing": {
        "above_then_175": { "doc_count": 0 },
        "hundred_to_175": { "doc_count": 0 },
        "less_than_100": { "doc_count": 1 }
      },
      "attributes": [
        {
          "type_name": "Compitable Browser",
          "filters": [
            { "key": "Boostrap 5.x", "doc_count": 1 },
            { "key": "CSS Files", "doc_count": 1 },
            { "key": "Chrome", "doc_count": 1 },
            { "key": "Edge", "doc_count": 1 },
            { "key": "Firefox", "doc_count": 1 },
            { "key": "HTML Files", "doc_count": 1 },
            { "key": "JS Files", "doc_count": 1 },
            { "key": "Opera", "doc_count": 1 },
            { "key": "Safari", "doc_count": 1 }
          ]
        }
      ]
    }
  }
}

Notes

• The result list is returned in data.items.
• Use the aggregations object to build filters (faceted search) in your UI.
• campaign_start_date and campaign_end_date can be null when a product is not on sale.