Search
The Search module provides product discovery for storefront-facing applications. It supports keyword search, faceted filters, autocomplete suggestions, and product listing pages backed by Vertex AI retail search.
Operations
GET
# Lists all products.
GET
# Browse products belonging to a collection.
GET
# Visual image-based product search.
GET
# Retrieves search result listings.
FDK Method Name: getProducts
List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
Parameters
q
string
The search query for entering partial or full name of product, brand, category, or collection.
f
string
The search filter parameters. Filter parameters will be passed in f parameter as shown in the example below. Double Pipe (||) denotes the OR condition, whereas Triple-colon (:::) indicates a new filter parameter applied as an AND condition.
filters
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
sort_on
string
The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order. See the supported values below.
Enum
page_id
string
Page ID to retrieve next set of results.
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_type
string
Available pagination types are cursor or number.
Default Value : cursor
Enum
store_ids
string
Comma-separated store / channel IDs (e.g. "AJIO,AJIO_INTL")
Response
200
Success. Returns a paginated list of products.
SearchProductListing
items
array of object
filters
array of object
page
object
sort_on
array of object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Lists all products.
getProducts
FDK Method Name: getCollectionProducts
Returns a paginated product listing filtered to the given collection slug. Supports both handpick and rules-based collections — the Vertex filter expression is resolved by the collection service; this endpoint has no branching logic.
Parameters
slug
string
Required
Collection slug identifier (e.g. summer-sale, new-arrivals).
f
string
Filter string — same format as /products (key:val:::key:val).
sort_on
string
Sort key — same values as /products.
Enum
page_id
string
Cursor token for the next page.
page_size
integer
Number of results per page.
Default Value : 12
page_no
integer
Page number (1-indexed).
Default Value : 1
page_type
string
Pagination mode — cursor or number.
Default Value : cursor
Enum
store_ids
string
Comma-separated store / channel IDs (e.g. "AJIO,AJIO_INTL")
Response
200
404
Success. Returns a paginated product listing for the collection.
SearchProductListing
items
array of object
filters
array of object
page
object
sort_on
array of object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Browse products belonging to a collection.
getCollectionProducts
FDK Method Name: getImageSearchProducts
Search for visually similar products by uploading an image (image_name) or refining a prior search using a ViSenze image ID (im_id + box). Returns the same product listing shape as /products plus a visual block containing the ViSenze session ID and detected product types.
Parameters
image_name
string
GCS object name or public image URL for a new visual search.
im_id
string
ViSenze im_id from a prior image search response (refinement flow).
box
string
Bounding box "x1,y1,x2,y2" — required when im_id is provided.
store
string
ViSenze store key for per-store credential resolution.
f
string
Filter string — same format as /products (key:val:::key:val).
sort_on
string
Sort key — same values as /products.
Enum
page
integer
0-indexed page number.
Default Value : 0
page_size
integer
Results per page (max 100).
Default Value : 20
product_type
string
Detected product type tag (e.g. outerwear, shoe). Actual filtering uses im_id + box.
store_ids
string
Comma-separated store / channel IDs (e.g. "AJIO,AJIO_INTL")
Response
200
Success. Returns a paginated product listing with visual session metadata.
ImageSearchProductListing
items
array of object
filters
array of object
page
object
sort_on
array of object
visual
object (VisualSearchBlock)
VisualSearchBlock
id
string
ViSenze session image ID for refinement flows.
product_types
array of object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Visual image-based product search.
getImageSearchProducts
FDK Method Name: getAutoComplete
Get products, brands, or categories based on a search query, which can be a partial or full name match.
Parameters
q
string
Required
The search query for entering partial or full name of a product, brand or category. For example, if the given search query `q` is _ski_, the relevant search suggestions could be _skirt_, _ski shoes_, _skin cream_ etc.
store_ids
string
Comma-separated store / channel IDs (e.g. "AJIO,AJIO_INTL")
Response
200
Success. Returns a list of autocomplete suggestions for the search query `q`.
SearchAutoComplete
items
array of object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response