Searchspring provides an API for searching and browsing the catalog of products indexed in your Searchspring account. The API provides the ability to return results based on a search query or a filter on a field (e.g. Category is "Running Shoes"). Searchspring will return results in JSON. The response will include products that match the search criteria, available facet options to further refine the results and any configured merchandising content like promotional banner images.
Search API URL
While performing a preview search to display product results within an AutoComplete modal, use the following endpoint to avoid muddying up your insights & reporting data:
This will function exactly the same as a normal search request, but will not affect your reporting.
Installing Product Finders?
If implementing Product Finders, you'll similarly need to use this endpoint to avoid muddying up your insights & reporting data:
|Description||The siteId parameter identifies your site. You can find your siteId on the My Account page.|
|Description||The search Query. Searches the database for the terms in the query. This can be blank or not included for pages without a search query.|
|Description||The landing page tag. Searches the database for products that are a part of that landing page. This will be blank or not included for non-landing page pages.|
|Description||Native will return raw JSON for products. HTML will generate HTML for your products based on Searchspring templates. Accepts "native" or "html".|
|Description||If you are using the Beacon Tracking API, this returns a "beacon" object in its response to pass along to the beacon.
Note: With the assumption that events are now being logged through the Beacon API, enabling this parameter on search requests will disable server-side logging from occurring.
curl -X GET https://api.searchspring.net/api/search/search?siteId=scmq7n&q=dress