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.imagemapping

But you can also fetch it directly from the API

GEThttps://mercury.plutocracy.io/config

Header parameters

Response

200

Returns the current Grid Config, Facet Map, Colour Map, Size Map etc

Request

JavaScriptCurlPython

const response = await fetch('https://mercury.plutocracy.io/config', {
    method: 'GET',
    headers: {
      "Origin": "text"
    },
});
const data = await response.json();

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

Available on Mercury Pro/Enterprise Plans

GEThttps://mercury.plutocracy.io/suggest/{term}

Path parameters

term*string

The term to search the Autocomplete Dictionary for

Header parameters

Response

200

Suggested autocomplete terms from the autocomplete dictionary

Request

JavaScriptCurlPython

const response = await fetch('https://mercury.plutocracy.io/suggest/{term}', {
    method: 'GET',
    headers: {
      "Origin": "text"
    },
});
const data = await response.json();

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

GEThttps://mercury.plutocracy.io/search/{term}

Path parameters

term*string

The term to search the Search Index for

Query parameters

Header parameters

Response

200

A complete Rendered Search

Body

application/json

search*string

facets*RenderedFacets (object)

products*array of array

query*array of string

redirect*string

suggested*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://mercury.plutocracy.io/search/{term}', {
    method: 'GET',
    headers: {
      "Origin": "text"
    },
});
const data = await response.json();

Response

200

{
  "search": "text",
  "facets": {
    "vendors": [
      {
        "vendor": "text",
        "count": 0
      }
    ],
    "types": [
      {
        "type": "text",
        "count": 0
      }
    ],
    "tags": [
      {
        "value": "text",
        "count": 0
      }
    ],
    "count": 0
  },
  "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

GEThttps://mercury.plutocracy.io/collection/{handle}

Query parameters

Header parameters

Response

200

A complete Rendered Collection

Body

application/json

id*number

rules*array of CollectionRules (object)

title*string

handle*string

body_html*string

metafields*object

sort_order*string

updated_at*string (date-time)

disjunctive*boolean

published_at*string (date-time)

collection_type*string

published_scope*string

template_suffix*string

admin_graphql_api_id*string

config*object

facets*RenderedFacets (object)

Request

JavaScriptCurlPython

const response = await fetch('https://mercury.plutocracy.io/collection/{handle}', {
    method: 'GET',
    headers: {
      "Origin": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": 0,
  "rules": [
    {
      "column": "text",
      "relation": "text",
      "condition": "text"
    }
  ],
  "title": "text",
  "handle": "text",
  "body_html": "text",
  "sort_order": "text",
  "updated_at": "2024-11-23T03:42:13.536Z",
  "disjunctive": false,
  "published_at": "2024-11-23T03:42:13.536Z",
  "collection_type": "text",
  "published_scope": "text",
  "template_suffix": "text",
  "admin_graphql_api_id": "text",
  "facets": {
    "vendors": [
      {
        "vendor": "text",
        "count": 0
      }
    ],
    "types": [
      {
        "type": "text",
        "count": 0
      }
    ],
    "tags": [
      {
        "value": "text",
        "count": 0
      }
    ],
    "count": 0
  }
}

Get Products

GEThttps://mercury.plutocracy.io/search/product/{handles}

Path parameters

handles*string

A comma separated list of product handles

Header parameters

Response

200

Up to 20 product objects, if only one handle is specified it will return an object

Body

application/json

id*string

title*string

implode*ExplodeType (enum)

123

handle*string

min_price*number

compare_at_min_price*number

vendor*string

type*string

on_sale*boolean

total_stock*number

variants*array of string

prices*PresentmentPrices (object)

created_date*string (date-time)

tags*array of string

image*string

images*array of string

related*string

Stringified Juno Related Products Object

meta*ProductMeta (object)

Request

JavaScriptCurlPython

const response = await fetch('https://mercury.plutocracy.io/search/product/{handles}', {
    method: 'GET',
    headers: {
      "Origin": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "title": "text",
    "implode": 1,
    "handle": "text",
    "min_price": 0,
    "compare_at_min_price": 0,
    "vendor": "text",
    "type": "text",
    "on_sale": false,
    "total_stock": 0,
    "variants": [
      "text"
    ],
    "prices": {},
    "created_date": "2024-11-23T03:42:13.536Z",
    "tags": [
      "text"
    ],
    "image": "text",
    "images": [
      "text"
    ],
    "related": "text",
    "meta": {
      "badges": [
        {
          "content": "text",
          "background": "text",
          "colour": "text",
          "positiony": "text",
          "positionx": "text",
          "classes": "text",
          "type": "text"
        }
      ]
    }
  }
]