Endpoints
Fetch a stores Public Config
Mercury exposes it's grid configuration object as a store metafield
store.metafields.MERCURY.grid
store.metafields.MERCURY.sizemapping
store.metafields.MERCURY.colourmapping
store.metafields.MERCURY.imagemappingBut you can also fetch it directly from the API
Whitelisted origins will return store data for a given URL - used for Production Traffic
A Mercury Provided Bypass Token, will provide scoped access to a stores data - used for Local Development
GET /config HTTP/1.1
Host: mercury.plutocracy.io
Origin: text
Accept: */*
Returns the current Grid Config, Facet Map, Colour Map, Size Map etc
No content
Search Endpoints
Mercury's core experience is our Search & Merch Engine. It consists of some key endpoints, which handle the heavy lifting for you to create seamless Search & Collection experiences using our embeddable experience or your own custom experience.
Suggest
Suggest returns a list of similar / popular search terms related to your query
The term to search the Autocomplete Dictionary for
Whitelisted origins will return store data for a given URL - used for Production Traffic
A Mercury Provided Bypass Token, will provide scoped access to a stores data - used for Local Development
GET /suggest/{term} HTTP/1.1
Host: mercury.plutocracy.io
Origin: text
Accept: */*
Suggested autocomplete terms from the autocomplete dictionary
No content
Search
Search returns a page of search results for a given search term
The engine will handle
Synonym Matching
Search Modifiers
Saved Searches
Redirects
Learn more here
The term to search the Search Index for
Allow the search to return similar search terms
Allow the search to return redirect URLs for the given search term
A page number to return the results from, pages are calculated from the take param (default 20)
Additional filter objects - Stringified
The amount of results to skip, should be a multiple of the "Take"
The amount of results to return, (max 50, default 20)
Whitelisted origins will return store data for a given URL - used for Production Traffic
A Mercury Provided Bypass Token, will provide scoped access to a stores data - used for Local Development
GET /search/{term} HTTP/1.1
Host: mercury.plutocracy.io
Origin: text
Accept: */*
A complete Rendered Search
{
"search": "text",
"facets": {
"vendors": [
{
"vendor": "text",
"count": 1
}
],
"types": [
{
"type": "text",
"count": 1
}
],
"tags": [
{
"value": "text",
"count": 1
}
],
"count": 1
},
"products": [
[]
],
"query": [
"text"
],
"redirect": "text",
"suggested": [
"text"
]
}Collection Endpoints
Collection returns a page of collection results for a given collection query term
The engine will handle
Sorting based on advanced rules
Collection merchandising content
Inline merchandising content
When constructing the grid, you will have to merge the merchandising content and the product content to match the configuration of the store's config to allow the mercury admin preview to match the end users collection experience
Learn more here
A page number to return the results from, pages are calculated from the take param (default 20)
Additional filter objects - Stringified
The amount of results to skip, should be a multiple of the "Take"
The amount of results to return, (max 50, default 20)
Whitelisted origins will return store data for a given URL - used for Production Traffic
A Mercury Provided Bypass Token, will provide scoped access to a stores data - used for Local Development
GET /collection/{handle} HTTP/1.1
Host: mercury.plutocracy.io
Origin: text
Accept: */*
A complete Rendered Collection
{
"id": 1,
"rules": [
{
"column": "text",
"relation": "text",
"condition": "text"
}
],
"title": "text",
"handle": "text",
"body_html": "text",
"metafields": {},
"sort_order": "text",
"updated_at": "2025-06-20T14:16:05.856Z",
"disjunctive": true,
"published_at": "2025-06-20T14:16:05.856Z",
"collection_type": "text",
"published_scope": "text",
"template_suffix": "text",
"admin_graphql_api_id": "text",
"config": {},
"facets": {
"vendors": [
{
"vendor": "text",
"count": 1
}
],
"types": [
{
"type": "text",
"count": 1
}
],
"tags": [
{
"value": "text",
"count": 1
}
],
"count": 1
}
}Get Products
A comma separated list of product handles
Whitelisted origins will return store data for a given URL - used for Production Traffic
A Mercury Provided Bypass Token, will provide scoped access to a stores data - used for Local Development
GET /search/product/{handles} HTTP/1.1
Host: mercury.plutocracy.io
Origin: text
Accept: */*
Up to 20 product objects, if only one handle is specified it will return an object
[
{
"id": "text",
"title": "text",
"implode": 1,
"handle": "text",
"min_price": 1,
"compare_at_min_price": 1,
"vendor": "text",
"type": "text",
"on_sale": true,
"total_stock": 1,
"variants": [
"text"
],
"prices": {},
"created_date": "2025-06-20T14:16:05.856Z",
"tags": [
"text"
],
"image": "text",
"images": [
"text"
],
"related": "text",
"meta": {
"reviews": {},
"badges": [
{
"content": "text",
"background": "text",
"colour": "text",
"positiony": "text",
"positionx": "text",
"classes": "text",
"type": "text"
}
]
}
}
]Last updated