Adobe Commerce only. Learn more.

Live Search API Reference

Populate all fields with information that is specific to the Magento account and storefront of the Magento Commerce license holder. The apiKey parameter should be hard coded to search_gql.

Create client

Parameter Type Description
environmentId string (Required)
Example:
beb38e17-2969-46bb-b294-e140ec60c212
websiteCode string (Required)
Example:
base
storeCode string (Required)
Example:
main_website_store
storeViewCode string (Required)
Example:
default
apiKey string (Required)
Example:
search_gql

productSearch

Scenario: Used on a search page to retrieve products and facets for filtering.

Parameter Type Required Example
phrase string (Required)
Example: yoga
 
page_size number   Default:20
Example: 10
current_page string Default:1
Example: 2
 
filter [] Default: []
Example:
[{attribute: "color", eq: "red"}]
 
sort [] Default: []
Example:
[{attribute: "price", direction: "ASC"}]
 

categorySearch

Scenario: Used on search page to retrieve categories for filtering.

Parameter Type Required Example
phrase string (Required)
Example: yoga
 
category_size number Default: 5
Example: 10
 

quickSearch

Scenario: Used in a search box to return product and category matches, as well as search suggestions.

Parameter Type Required Example
phrase string (Required)
Example: yoga
 
category_size number Default: 10
Example: 20
 
page_size number Default: 10
Example: 20
 
current_page string Default: 1
Example: 2
 
filter [] Default: []
Example:
[{attribute: "color", eq: "red"}]
 
sort [] Default: []
Example:
[{attribute: "price", direction: "ASC"}]