Content Search: Execute Search
curl --request POST \
--url https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute \
--header 'Accept: <accept>' \
--header 'Content-Type: <content-type>' \
--header 'X-Storefront-Access-Token: <x-storefront-access-token>' \
--data '
{
"content_type": "<string>",
"pagination": {
"page": 123,
"limit": 123
},
"tuning": {
"textualWeight": 123,
"visualWeight": 123,
"topK": 123,
"rankingWeightOverrides": {}
},
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"context": {
"geo": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"productsInCart": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {},
"quantity": 123
}
],
"freeShippingThreshold": 123,
"productsViewed": [
{
"id": "<string>",
"at": 123,
"title": "<string>",
"type": "<string>",
"variantId": "<string>",
"options": {}
}
],
"productsPurchased": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {}
}
],
"priorSearches": [
{
"searchQuery": "<string>",
"hadClick": true,
"hasResults": true,
"fromPage": "<string>"
}
],
"marketing": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>",
"clickIds": {}
},
"experiments": {},
"customer": {
"signedIn": true,
"returning": true,
"numberOfOrders": 123,
"averageOrderValue": 123,
"daysBetweenOrders": 123,
"daysSinceLastOrder": 123,
"daysSinceOldestOrder": 123,
"totalSpent": 123,
"tags": [
{}
],
"segments": [
{}
]
},
"market": "<string>",
"session": {
"returning": true
},
"locale": "<string>",
"currency": "<string>",
"b2bCompany": "<string>",
"shoppingChannel": "<string>",
"custom": {}
}
}
'import requests
url = "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute"
payload = {
"content_type": "<string>",
"pagination": {
"page": 123,
"limit": 123
},
"tuning": {
"textualWeight": 123,
"visualWeight": 123,
"topK": 123,
"rankingWeightOverrides": {}
},
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"context": {
"geo": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"productsInCart": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {},
"quantity": 123
}
],
"freeShippingThreshold": 123,
"productsViewed": [
{
"id": "<string>",
"at": 123,
"title": "<string>",
"type": "<string>",
"variantId": "<string>",
"options": {}
}
],
"productsPurchased": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {}
}
],
"priorSearches": [
{
"searchQuery": "<string>",
"hadClick": True,
"hasResults": True,
"fromPage": "<string>"
}
],
"marketing": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>",
"clickIds": {}
},
"experiments": {},
"customer": {
"signedIn": True,
"returning": True,
"numberOfOrders": 123,
"averageOrderValue": 123,
"daysBetweenOrders": 123,
"daysSinceLastOrder": 123,
"daysSinceOldestOrder": 123,
"totalSpent": 123,
"tags": [{}],
"segments": [{}]
},
"market": "<string>",
"session": { "returning": True },
"locale": "<string>",
"currency": "<string>",
"b2bCompany": "<string>",
"shoppingChannel": "<string>",
"custom": {}
}
}
headers = {
"X-Storefront-Access-Token": "<x-storefront-access-token>",
"Content-Type": "<content-type>",
"Accept": "<accept>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Storefront-Access-Token': '<x-storefront-access-token>',
'Content-Type': '<content-type>',
Accept: '<accept>'
},
body: JSON.stringify({
content_type: '<string>',
pagination: {page: 123, limit: 123},
tuning: {textualWeight: 123, visualWeight: 123, topK: 123, rankingWeightOverrides: {}},
identity: {
deviceId: '<string>',
sessionId: '<string>',
customerId: '<string>',
companyLocationId: '<string>'
},
context: {
geo: {country: '<string>', province: '<string>', city: '<string>'},
productsInCart: [
{
title: '<string>',
price: 123,
type: '<string>',
productId: '<string>',
variantId: '<string>',
options: {},
quantity: 123
}
],
freeShippingThreshold: 123,
productsViewed: [
{
id: '<string>',
at: 123,
title: '<string>',
type: '<string>',
variantId: '<string>',
options: {}
}
],
productsPurchased: [
{
title: '<string>',
price: 123,
type: '<string>',
productId: '<string>',
variantId: '<string>',
options: {}
}
],
priorSearches: [
{
searchQuery: '<string>',
hadClick: true,
hasResults: true,
fromPage: '<string>'
}
],
marketing: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
term: '<string>',
content: '<string>',
clickIds: {}
},
experiments: {},
customer: {
signedIn: true,
returning: true,
numberOfOrders: 123,
averageOrderValue: 123,
daysBetweenOrders: 123,
daysSinceLastOrder: 123,
daysSinceOldestOrder: 123,
totalSpent: 123,
tags: [{}],
segments: [{}]
},
market: '<string>',
session: {returning: true},
locale: '<string>',
currency: '<string>',
b2bCompany: '<string>',
shoppingChannel: '<string>',
custom: {}
}
})
};
fetch('https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content_type' => '<string>',
'pagination' => [
'page' => 123,
'limit' => 123
],
'tuning' => [
'textualWeight' => 123,
'visualWeight' => 123,
'topK' => 123,
'rankingWeightOverrides' => [
]
],
'identity' => [
'deviceId' => '<string>',
'sessionId' => '<string>',
'customerId' => '<string>',
'companyLocationId' => '<string>'
],
'context' => [
'geo' => [
'country' => '<string>',
'province' => '<string>',
'city' => '<string>'
],
'productsInCart' => [
[
'title' => '<string>',
'price' => 123,
'type' => '<string>',
'productId' => '<string>',
'variantId' => '<string>',
'options' => [
],
'quantity' => 123
]
],
'freeShippingThreshold' => 123,
'productsViewed' => [
[
'id' => '<string>',
'at' => 123,
'title' => '<string>',
'type' => '<string>',
'variantId' => '<string>',
'options' => [
]
]
],
'productsPurchased' => [
[
'title' => '<string>',
'price' => 123,
'type' => '<string>',
'productId' => '<string>',
'variantId' => '<string>',
'options' => [
]
]
],
'priorSearches' => [
[
'searchQuery' => '<string>',
'hadClick' => true,
'hasResults' => true,
'fromPage' => '<string>'
]
],
'marketing' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'term' => '<string>',
'content' => '<string>',
'clickIds' => [
]
],
'experiments' => [
],
'customer' => [
'signedIn' => true,
'returning' => true,
'numberOfOrders' => 123,
'averageOrderValue' => 123,
'daysBetweenOrders' => 123,
'daysSinceLastOrder' => 123,
'daysSinceOldestOrder' => 123,
'totalSpent' => 123,
'tags' => [
[
]
],
'segments' => [
[
]
]
],
'market' => '<string>',
'session' => [
'returning' => true
],
'locale' => '<string>',
'currency' => '<string>',
'b2bCompany' => '<string>',
'shoppingChannel' => '<string>',
'custom' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Content-Type: <content-type>",
"X-Storefront-Access-Token: <x-storefront-access-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute"
payload := strings.NewReader("{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Storefront-Access-Token", "<x-storefront-access-token>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Accept", "<accept>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute")
.header("X-Storefront-Access-Token", "<x-storefront-access-token>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.body("{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Storefront-Access-Token"] = '<x-storefront-access-token>'
request["Content-Type"] = '<content-type>'
request["Accept"] = '<accept>'
request.body = "{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"query": "sustainable fashion tips",
"contentType": null,
"resultsPerPage": 20,
"totalResults": 14,
"page": 1,
"totalPages": 1,
"results": [
{
"__typename": "Article",
"content_type": "article",
"content_id": 12345678901,
"title": "10 Ways to Build a Sustainable Wardrobe",
"handle": "sustainable-wardrobe-tips",
"summary_text": "Discover practical tips for creating an eco-friendly wardrobe that's both stylish and sustainable.",
"author": "Emma Green",
"tags": ["sustainability", "fashion", "eco-friendly"],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/articles/sustainable-fashion.jpg",
"width": 1200,
"height": 630,
"altText": "Sustainable Fashion Guide"
},
"published_at": "2024-06-01T12:00:00Z",
"blog_title": "The Journal",
"url": "/blogs/journal/sustainable-wardrobe-tips"
},
{
"__typename": "Page",
"content_type": "page",
"content_id": 98765432101,
"title": "Our Sustainability Commitment",
"handle": "sustainability",
"summary_text": "Learn about our commitment to ethical sourcing and sustainable materials across all product lines.",
"author": null,
"tags": [],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/files/sustainability-hero.jpg",
"width": 1600,
"height": 900,
"altText": "Sustainability page hero"
},
"published_at": "2024-03-15T10:00:00Z",
"blog_title": null,
"url": "/pages/sustainability"
}
]
}
Content Search
Content Search: Execute Search
Content Search API endpoint to run semantic queries across blog articles, knowledge base pages, and other non-product content in your catalog.
POST
/
search
/
content
/
{searchQuery}
/
execute
Content Search: Execute Search
curl --request POST \
--url https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute \
--header 'Accept: <accept>' \
--header 'Content-Type: <content-type>' \
--header 'X-Storefront-Access-Token: <x-storefront-access-token>' \
--data '
{
"content_type": "<string>",
"pagination": {
"page": 123,
"limit": 123
},
"tuning": {
"textualWeight": 123,
"visualWeight": 123,
"topK": 123,
"rankingWeightOverrides": {}
},
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"context": {
"geo": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"productsInCart": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {},
"quantity": 123
}
],
"freeShippingThreshold": 123,
"productsViewed": [
{
"id": "<string>",
"at": 123,
"title": "<string>",
"type": "<string>",
"variantId": "<string>",
"options": {}
}
],
"productsPurchased": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {}
}
],
"priorSearches": [
{
"searchQuery": "<string>",
"hadClick": true,
"hasResults": true,
"fromPage": "<string>"
}
],
"marketing": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>",
"clickIds": {}
},
"experiments": {},
"customer": {
"signedIn": true,
"returning": true,
"numberOfOrders": 123,
"averageOrderValue": 123,
"daysBetweenOrders": 123,
"daysSinceLastOrder": 123,
"daysSinceOldestOrder": 123,
"totalSpent": 123,
"tags": [
{}
],
"segments": [
{}
]
},
"market": "<string>",
"session": {
"returning": true
},
"locale": "<string>",
"currency": "<string>",
"b2bCompany": "<string>",
"shoppingChannel": "<string>",
"custom": {}
}
}
'import requests
url = "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute"
payload = {
"content_type": "<string>",
"pagination": {
"page": 123,
"limit": 123
},
"tuning": {
"textualWeight": 123,
"visualWeight": 123,
"topK": 123,
"rankingWeightOverrides": {}
},
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"context": {
"geo": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"productsInCart": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {},
"quantity": 123
}
],
"freeShippingThreshold": 123,
"productsViewed": [
{
"id": "<string>",
"at": 123,
"title": "<string>",
"type": "<string>",
"variantId": "<string>",
"options": {}
}
],
"productsPurchased": [
{
"title": "<string>",
"price": 123,
"type": "<string>",
"productId": "<string>",
"variantId": "<string>",
"options": {}
}
],
"priorSearches": [
{
"searchQuery": "<string>",
"hadClick": True,
"hasResults": True,
"fromPage": "<string>"
}
],
"marketing": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>",
"clickIds": {}
},
"experiments": {},
"customer": {
"signedIn": True,
"returning": True,
"numberOfOrders": 123,
"averageOrderValue": 123,
"daysBetweenOrders": 123,
"daysSinceLastOrder": 123,
"daysSinceOldestOrder": 123,
"totalSpent": 123,
"tags": [{}],
"segments": [{}]
},
"market": "<string>",
"session": { "returning": True },
"locale": "<string>",
"currency": "<string>",
"b2bCompany": "<string>",
"shoppingChannel": "<string>",
"custom": {}
}
}
headers = {
"X-Storefront-Access-Token": "<x-storefront-access-token>",
"Content-Type": "<content-type>",
"Accept": "<accept>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Storefront-Access-Token': '<x-storefront-access-token>',
'Content-Type': '<content-type>',
Accept: '<accept>'
},
body: JSON.stringify({
content_type: '<string>',
pagination: {page: 123, limit: 123},
tuning: {textualWeight: 123, visualWeight: 123, topK: 123, rankingWeightOverrides: {}},
identity: {
deviceId: '<string>',
sessionId: '<string>',
customerId: '<string>',
companyLocationId: '<string>'
},
context: {
geo: {country: '<string>', province: '<string>', city: '<string>'},
productsInCart: [
{
title: '<string>',
price: 123,
type: '<string>',
productId: '<string>',
variantId: '<string>',
options: {},
quantity: 123
}
],
freeShippingThreshold: 123,
productsViewed: [
{
id: '<string>',
at: 123,
title: '<string>',
type: '<string>',
variantId: '<string>',
options: {}
}
],
productsPurchased: [
{
title: '<string>',
price: 123,
type: '<string>',
productId: '<string>',
variantId: '<string>',
options: {}
}
],
priorSearches: [
{
searchQuery: '<string>',
hadClick: true,
hasResults: true,
fromPage: '<string>'
}
],
marketing: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
term: '<string>',
content: '<string>',
clickIds: {}
},
experiments: {},
customer: {
signedIn: true,
returning: true,
numberOfOrders: 123,
averageOrderValue: 123,
daysBetweenOrders: 123,
daysSinceLastOrder: 123,
daysSinceOldestOrder: 123,
totalSpent: 123,
tags: [{}],
segments: [{}]
},
market: '<string>',
session: {returning: true},
locale: '<string>',
currency: '<string>',
b2bCompany: '<string>',
shoppingChannel: '<string>',
custom: {}
}
})
};
fetch('https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content_type' => '<string>',
'pagination' => [
'page' => 123,
'limit' => 123
],
'tuning' => [
'textualWeight' => 123,
'visualWeight' => 123,
'topK' => 123,
'rankingWeightOverrides' => [
]
],
'identity' => [
'deviceId' => '<string>',
'sessionId' => '<string>',
'customerId' => '<string>',
'companyLocationId' => '<string>'
],
'context' => [
'geo' => [
'country' => '<string>',
'province' => '<string>',
'city' => '<string>'
],
'productsInCart' => [
[
'title' => '<string>',
'price' => 123,
'type' => '<string>',
'productId' => '<string>',
'variantId' => '<string>',
'options' => [
],
'quantity' => 123
]
],
'freeShippingThreshold' => 123,
'productsViewed' => [
[
'id' => '<string>',
'at' => 123,
'title' => '<string>',
'type' => '<string>',
'variantId' => '<string>',
'options' => [
]
]
],
'productsPurchased' => [
[
'title' => '<string>',
'price' => 123,
'type' => '<string>',
'productId' => '<string>',
'variantId' => '<string>',
'options' => [
]
]
],
'priorSearches' => [
[
'searchQuery' => '<string>',
'hadClick' => true,
'hasResults' => true,
'fromPage' => '<string>'
]
],
'marketing' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'term' => '<string>',
'content' => '<string>',
'clickIds' => [
]
],
'experiments' => [
],
'customer' => [
'signedIn' => true,
'returning' => true,
'numberOfOrders' => 123,
'averageOrderValue' => 123,
'daysBetweenOrders' => 123,
'daysSinceLastOrder' => 123,
'daysSinceOldestOrder' => 123,
'totalSpent' => 123,
'tags' => [
[
]
],
'segments' => [
[
]
]
],
'market' => '<string>',
'session' => [
'returning' => true
],
'locale' => '<string>',
'currency' => '<string>',
'b2bCompany' => '<string>',
'shoppingChannel' => '<string>',
'custom' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Content-Type: <content-type>",
"X-Storefront-Access-Token: <x-storefront-access-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute"
payload := strings.NewReader("{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Storefront-Access-Token", "<x-storefront-access-token>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Accept", "<accept>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute")
.header("X-Storefront-Access-Token", "<x-storefront-access-token>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.body("{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uselayers.com/api/storefront/v1/search/content/{searchQuery}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Storefront-Access-Token"] = '<x-storefront-access-token>'
request["Content-Type"] = '<content-type>'
request["Accept"] = '<accept>'
request.body = "{\n \"content_type\": \"<string>\",\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"tuning\": {\n \"textualWeight\": 123,\n \"visualWeight\": 123,\n \"topK\": 123,\n \"rankingWeightOverrides\": {}\n },\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"context\": {\n \"geo\": {\n \"country\": \"<string>\",\n \"province\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"productsInCart\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {},\n \"quantity\": 123\n }\n ],\n \"freeShippingThreshold\": 123,\n \"productsViewed\": [\n {\n \"id\": \"<string>\",\n \"at\": 123,\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"productsPurchased\": [\n {\n \"title\": \"<string>\",\n \"price\": 123,\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"options\": {}\n }\n ],\n \"priorSearches\": [\n {\n \"searchQuery\": \"<string>\",\n \"hadClick\": true,\n \"hasResults\": true,\n \"fromPage\": \"<string>\"\n }\n ],\n \"marketing\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\",\n \"clickIds\": {}\n },\n \"experiments\": {},\n \"customer\": {\n \"signedIn\": true,\n \"returning\": true,\n \"numberOfOrders\": 123,\n \"averageOrderValue\": 123,\n \"daysBetweenOrders\": 123,\n \"daysSinceLastOrder\": 123,\n \"daysSinceOldestOrder\": 123,\n \"totalSpent\": 123,\n \"tags\": [\n {}\n ],\n \"segments\": [\n {}\n ]\n },\n \"market\": \"<string>\",\n \"session\": {\n \"returning\": true\n },\n \"locale\": \"<string>\",\n \"currency\": \"<string>\",\n \"b2bCompany\": \"<string>\",\n \"shoppingChannel\": \"<string>\",\n \"custom\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"query": "sustainable fashion tips",
"contentType": null,
"resultsPerPage": 20,
"totalResults": 14,
"page": 1,
"totalPages": 1,
"results": [
{
"__typename": "Article",
"content_type": "article",
"content_id": 12345678901,
"title": "10 Ways to Build a Sustainable Wardrobe",
"handle": "sustainable-wardrobe-tips",
"summary_text": "Discover practical tips for creating an eco-friendly wardrobe that's both stylish and sustainable.",
"author": "Emma Green",
"tags": ["sustainability", "fashion", "eco-friendly"],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/articles/sustainable-fashion.jpg",
"width": 1200,
"height": 630,
"altText": "Sustainable Fashion Guide"
},
"published_at": "2024-06-01T12:00:00Z",
"blog_title": "The Journal",
"url": "/blogs/journal/sustainable-wardrobe-tips"
},
{
"__typename": "Page",
"content_type": "page",
"content_id": 98765432101,
"title": "Our Sustainability Commitment",
"handle": "sustainability",
"summary_text": "Learn about our commitment to ethical sourcing and sustainable materials across all product lines.",
"author": null,
"tags": [],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/files/sustainability-hero.jpg",
"width": 1600,
"height": 900,
"altText": "Sustainability page hero"
},
"published_at": "2024-03-15T10:00:00Z",
"blog_title": null,
"url": "/pages/sustainability"
}
]
}
Authorization
string
required
Token-based authentication header in the form of
<YOUR_LAYERS_TOKEN>.Headers
string
default:"application/json"
required
string
default:"application/json"
required
Path parameters
string
required
The url-encoded search query. Layers normalizes the query before validating it, stripping invisible characters and converting Unicode punctuation to ASCII equivalents. After normalization, the query must be 2 to 255 characters. Queries outside this range return HTTP 422.
Body
string
Filter results by content type. Supported values:
"article" and "page". When omitted, all content types are searched and results from both articles and pages are returned together.Pagination Object
object
Override default ranking weights for content search.
Show Properties
Show Properties
number
Weight for textual (semantic text) similarity in ranking, between
0 and 1. Required when visualWeight is provided.number
Weight for visual (image) similarity in ranking, between
0 and 1. Required when textualWeight is provided.integer
Number of candidate results to retrieve before re-ranking, between
1 and 100.object
Override the default ranking model weights for this request. Each key is a signal group name and the value is a weight between
0 and 1. Content search supports the following groups:semantic— controls how much text and image similarity contribute to the score.freshness— controls how much publication recency contributes to the score.
object
User identity information for tracking and personalization. Automatically managed by the Storefront Pixel; required for headless integrations.
Show Properties
Show Properties
string
Persistent browser identifier that remains constant across sessions. Used to recognize returning visitors for long-term personalization. Automatically generated and managed by the Storefront Pixel.
string
Temporary session identifier. Layers-generated sessions expire after 30 minutes without activity. The Storefront Pixel refreshes the rolling window at page load and on every route change, including pages without tracked events. When a legacy Shopify or fallback cookie is available, Layers prefers it and does not control its lifetime. Without consent, the pixel uses a sessionStorage or in-memory fallback and does not write an analytics cookie.
string
Shopify customer ID for authenticated users. Only present when the customer is signed in to their account.
string
Shopify B2B company location GID (e.g.
gid://shopify/CompanyLocation/123456789) for the authenticated buyer. Layers resolves the catalog assigned to the company location and uses it to scope results: only products in the catalog are returned, prices come from the catalog’s price list, and excluded collections return 404. Omit for retail (DTC) traffic.When you pass companyLocationId, you must also pass the buyer’s customerId. Layers verifies with Shopify that the customer belongs to the company that owns the location before resolving the catalog; unauthorized or unauthenticated requests return a 403. See B2B catalogs.object
Contextual information about the customer’s session, behavior, and environment. Automatically collected by the Storefront Pixel; must be manually provided for headless integrations. See Contextual Information for implementation guidance.
Show Properties
Show Properties
object
Geographic location information for regional personalization and merchandising. Layers determines it from the IP address for client-side requests. For server-side API calls (headless integrations), provide
geo explicitly.array
Products currently in the customer’s cart. Used to surface complementary products and influence relevance scoring.
Show Array Item Properties
Show Array Item Properties
string
Product title. Each entry needs at least a
productId, variantId, or non-empty title. Layers drops entries with none of these.number
Unit price in the request currency’s major units (e.g.
29.00 for $29), not cents. Accepts a JSON number or a numeric string such as "29.00".string
Product type or category.
string
Product identifier. Accepts a numeric ID (e.g.,
"8234567890123") or a Shopify GID (e.g., "gid://shopify/Product/8234567890123").string
Product variant identifier.
object
Product variant options (e.g.,
{"Size": "11", "Color": "Red"}).integer
Number of units of this line in the cart. Layers rounds fractional values down to a whole number. Missing values, non-numeric values, and values below
1 count as 1. Layers uses it to calculate the cart subtotal for Free Shipping Picks.number
The cart subtotal at which the shopper qualifies for free shipping, in the request currency’s major units (e.g.
75.00 for $75), not cents. Layers ignores values that aren’t a number greater than 0. Required for Free Shipping Picks blocks.Shopify’s
/cart.js and Liquid money values such as cart.total_price and item.price are in cents. Divide them by 100 before sending productsInCart[].price or freeShippingThreshold.array
Products the shopper has viewed during the current session. Layers uses these as short-lived personalization signals, with recent views weighted more heavily. Only the 20 most recent views are used. The Storefront Pixel populates this automatically; send it manually only for headless integrations. See Recently viewed products.
Show Array Item Properties
Show Array Item Properties
string
Product identifier. Accepts a numeric ID or a Shopify GID. Also accepted as
productId.integer
Timestamp of the view in Unix milliseconds. Views without
at still count but skip recency weighting.string
Product title.
string
Product type or category.
string
Variant identifier, if the shopper viewed a specific variant.
object
Product variant options (e.g.,
{"Size": "11", "Color": "Red"}).array
Products the customer has previously purchased. Informs recommendations and prevents over-promotion of owned items.
Show Array Item Properties
Show Array Item Properties
string
Product title. Each entry needs at least a
productId, variantId, or non-empty title. Layers drops entries with none of these.number
Unit price in the request currency’s major units (e.g.
29.00 for $29), not cents, at time of purchase. Accepts a JSON number or a numeric string such as "29.00".string
Product type or category.
string
Product identifier. Accepts a numeric ID (e.g.,
"8234567890123") or a Shopify GID (e.g., "gid://shopify/Product/8234567890123").string
Product variant identifier.
object
Product variant options (e.g.,
{"Size": "11", "Color": "Red"}).array
Recent search queries and their outcomes. Helps understand customer intent and refine relevance models.
Show Array Item Properties
Show Array Item Properties
string
required
The search query text.
boolean
default:"false"
Whether the customer clicked on any results from this search.
boolean
default:"false"
Whether the search returned any results.
string
The page the search was started from (e.g., the referring page URL or page type). Layers accepts this field but doesn’t currently use it for ranking or rules.
object
UTM parameters and marketing campaign information for attribution tracking.
Show Properties
Show Properties
string
Marketing source (e.g., “google”, “facebook”).
string
Marketing medium (e.g., “cpc”, “email”, “social”).
string
Campaign name.
string
Search term or keyword.
string
Ad or link variant, such as the value of
utm_content.object
Click identifiers from the landing URL, keyed by parameter name (e.g.,
fbclid, gclid). Layers derives the originating network from them as marketing.clickSource and discards the raw tokens. See Context data structure.object
A/B test assignments for the shopper, keyed by experiment ID with the assigned group ID as the value (e.g.,
{"exp_123": "group_b"}). Used by the Experiment Group contextual condition. The Layers app embed fills this from Intelligems automatically; values your storefront sends for the same experiment take precedence. Entries whose value isn’t a string are dropped.object
Aggregated customer behavior and purchase patterns for personalization.
Show Properties
Show Properties
boolean
Whether the customer is currently authenticated.
boolean
Whether this is a returning customer.
integer
Total number of orders placed.
number
Average order value in store currency.
integer
Average days between orders.
integer
Days since the most recent order.
integer
Days since the first order.
number
Total amount spent in store currency.
array
Shopify customer tags on the shopper’s profile (e.g.,
["vip", "wholesale"]). Collected by the Storefront Pixel for signed-in customers; null for guests.array
Shopify customer segment IDs the shopper belongs to. Server-resolved: Layers populates this from the signed-in
identity.customerId on every request and ignores any value you send. null for guests and customers with no segment memberships. Available as context.customer.segments in contextual conditions.string
Explicitly set the Shopify Market for this request. Must be provided inside
context; it is not a top-level request body parameter. Used for market-specific product availability filtering and contextual pricing. Accepts a two-letter country code (e.g., "US", "CA"), a numeric Shopify Market ID (e.g., "12345"), or a Shopify Market GID (e.g., "gid://shopify/Market/12345").When not provided, the market is automatically resolved from context.geo.country (or the shopper’s detected country for client-side requests). If no matching market is found, the store’s primary market is used as the fallback.When you send a two-letter country code that belongs to the resolved market, Layers also prices for that country, ahead of the shopper’s detected location. See Market resolution.Behavior depends on the store’s market application mode (set under Settings > Search & Discovery > Search Behavior, in the Markets card):- Restrict to market catalog — Products are filtered to only those available in the resolved market, and market-specific pricing is applied
- Adjust pricing only — The full catalog remains visible, but variant prices are swapped to market-specific values where available
- Ignore markets (default) — Market resolution is skipped entirely; base catalog and base pricing are used for all shoppers
object
Session-level signals about the current visit.
Show Properties
Show Properties
boolean
Whether the current session belongs to a returning visitor. Layers derives this from the storefront’s session cookie when not provided.
string
Storefront locale code (e.g.,
"en", "fr", "pt-br"). Case-insensitive; Layers normalizes to lowercase.string
ISO 4217 currency code (e.g.,
"USD", "EUR"). Case-insensitive; Layers normalizes to uppercase. When Layers can resolve a currency from the shopper’s market or pricing context, the server-resolved value takes precedence.string
Shopify B2B company location identifier. When
identity.companyLocationId is provided, Layers resolves the company location server-side and the server value takes precedence.string
default:"web"
The shopping channel the customer is browsing from. Used for channel-specific merchandising, sorting, and analytics segmentation. Automatically detected from request headers when not provided (e.g., mobile app requests via Tapcart, Fuego, or Mobiloud Canvas are detected as
"app").Accepted values:"web"— Standard web browser (default)"app"— Mobile app (e.g., Tapcart, Fuego, Mobiloud Canvas)
object
Custom contextual data specific to your implementation. Structure is flexible and can contain any key-value pairs relevant to your use case.
Response
array
Array of content items matching the search query. Results can include both articles and pages when no
content_type filter is applied. Each item includes:Show Content item properties
Show Content item properties
string
The content type identifier. Returns
"Article" for blog articles or "Page" for Shopify pages.string
The content type:
"article" or "page".number
The unique identifier for the content item.
string
The content title.
string
The URL handle for the content item.
string
The content summary with HTML tags stripped (except images).
string
The author name. For pages, this may be
null.array
Array of tags associated with the content item. For pages, this is an empty array.
object
string
ISO 8601 timestamp of when the content was published.
string
The title of the blog the article belongs to. For pages, or for articles that haven’t synced blog data yet, this is
null.string
The root-relative storefront URL for the content item. Articles return
/blogs/{blog_handle}/{handle} and pages return /pages/{handle}. For articles that haven’t synced blog data yet, this is null.string
The search query that was executed.
string
The content type filter applied, if any.
number
The total number of results matching the search query.
number
The current page number.
number
The total number of pages.
number
The number of results per page.
Response headers
| Header | Description |
|---|---|
x-request-id | A unique identifier (ULID) for the request. Use it to correlate requests across your infrastructure or when contacting support. |
x-layers-build | The Layers build version that served the request. |
Supported content types
Content search indexes two types of Shopify content:| Content type | __typename | Description |
|---|---|---|
| Articles | "Article" | Blog posts from your Shopify blog. Includes author, tags, and blog association. |
| Pages | "Page" | Shopify pages (e.g., About Us, FAQ, Size Guide). Includes featured images when available. |
content_type parameter, results from both articles and pages are returned together, ranked by a unified scoring model. Use the __typename field to distinguish between content types when rendering results.
Search behavior
Content search uses a configurable ranking model to score and rank results. The default model combines three signal groups:| Signal group | Default weight | What it measures |
|---|---|---|
| Semantic (text) | 50% | How closely the content text matches the meaning of the query |
| Semantic (image) | 20% | How closely the content’s images match the query |
| Freshness | 30% | How recently the content was published (newer items score higher) |
tuning.rankingWeightOverrides parameter. For product search testing, use Test text search in Lab.
Image indexing for articles
Layers indexes up to 10 images per article for the image similarity signal. The featured image is always indexed first, followed by images from the article body in the order they appear. Images beyond the first 10 do not contribute to image similarity scores. Text and image indexing are independent. When an article is created or updated, its text becomes searchable immediately, and image similarity may follow shortly after. Text results are never delayed by image processing.Error handling
When search processing fails (e.g., due to rate limits or service issues), the API returns an empty result set withtotalResults: 0 rather than throwing an error, so your content search UI can render an empty state instead of failing.
{
"query": "sustainable fashion tips",
"contentType": null,
"resultsPerPage": 20,
"totalResults": 14,
"page": 1,
"totalPages": 1,
"results": [
{
"__typename": "Article",
"content_type": "article",
"content_id": 12345678901,
"title": "10 Ways to Build a Sustainable Wardrobe",
"handle": "sustainable-wardrobe-tips",
"summary_text": "Discover practical tips for creating an eco-friendly wardrobe that's both stylish and sustainable.",
"author": "Emma Green",
"tags": ["sustainability", "fashion", "eco-friendly"],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/articles/sustainable-fashion.jpg",
"width": 1200,
"height": 630,
"altText": "Sustainable Fashion Guide"
},
"published_at": "2024-06-01T12:00:00Z",
"blog_title": "The Journal",
"url": "/blogs/journal/sustainable-wardrobe-tips"
},
{
"__typename": "Page",
"content_type": "page",
"content_id": 98765432101,
"title": "Our Sustainability Commitment",
"handle": "sustainability",
"summary_text": "Learn about our commitment to ethical sourcing and sustainable materials across all product lines.",
"author": null,
"tags": [],
"image": {
"url": "https://cdn.shopify.com/s/files/1/0588/3677/9194/files/sustainability-hero.jpg",
"width": 1600,
"height": 900,
"altText": "Sustainability page hero"
},
"published_at": "2024-03-15T10:00:00Z",
"blog_title": null,
"url": "/pages/sustainability"
}
]
}
Usage example
cURL (all content types)
curl -X POST "https://app.uselayers.com/api/storefront/v1/search/content/sustainable%20fashion/execute" \
-H "X-Storefront-Access-Token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pagination": {
"page": 1,
"limit": 20
},
"context": {
"geo": {
"country": "US"
},
"shoppingChannel": "web"
},
"identity": {
"sessionId": "abc123",
"deviceId": "device-uuid"
}
}'
cURL (pages only)
curl -X POST "https://app.uselayers.com/api/storefront/v1/search/content/return%20policy/execute" \
-H "X-Storefront-Access-Token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"content_type": "page",
"pagination": {
"page": 1,
"limit": 20
}
}'
Content sync: Articles and pages are automatically synced from Shopify via webhooks and bulk operations. Only published content without the
seo.hidden metafield is included in search results. Setting seo.hidden also removes the item from Shopify’s own search and sitemap.xml. To exclude articles or pages from Layers search only, use a hidden content rule with a metafield condition instead.Was this page helpful?