Browse API: Browse Collection Page
curl --request POST \
--url https://app.uselayers.com/api/storefront/v1/browse/{collection_handle} \
--header 'Accept: <accept>' \
--header 'Content-Type: <content-type>' \
--header 'X-Storefront-Access-Token: <x-storefront-access-token>' \
--data '
{
"sort_order_code": "<string>",
"dynamicLinking": {
"products": [
{}
],
"offset": 123
},
"defaultSelectedOptions": [
{
"optionCode": "<string>",
"value": "<string>"
}
],
"attributes": [
"<string>"
],
"filter_group": {},
"pagination": {
"page": 123,
"limit": 123
},
"facets": [
"<string>"
],
"retrieveFacetCount": true,
"includeFacetRanges": true,
"enrichFacetMetaobjects": true,
"discountEntitlements": [
{
"entitled": {
"all": true,
"products": [
"<string>"
],
"variants": [
{}
],
"collections": [
"<string>"
],
"conditions": {}
},
"discount": {
"type": "<string>",
"value": 123
}
}
],
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"preview_id": "<string>",
"forceHideOutOfStock": true,
"grid": {
"columns": 123,
"device": "<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": {}
},
"responseOptions": {
"mediaPreloads": {
"enabled": true,
"srcsetSizes": [
123
],
"sizes": "<string>"
}
}
}
'import requests
url = "https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}"
payload = {
"sort_order_code": "<string>",
"dynamicLinking": {
"products": [{}],
"offset": 123
},
"defaultSelectedOptions": [
{
"optionCode": "<string>",
"value": "<string>"
}
],
"attributes": ["<string>"],
"filter_group": {},
"pagination": {
"page": 123,
"limit": 123
},
"facets": ["<string>"],
"retrieveFacetCount": True,
"includeFacetRanges": True,
"enrichFacetMetaobjects": True,
"discountEntitlements": [
{
"entitled": {
"all": True,
"products": ["<string>"],
"variants": [{}],
"collections": ["<string>"],
"conditions": {}
},
"discount": {
"type": "<string>",
"value": 123
}
}
],
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"preview_id": "<string>",
"forceHideOutOfStock": True,
"grid": {
"columns": 123,
"device": "<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": {}
},
"responseOptions": { "mediaPreloads": {
"enabled": True,
"srcsetSizes": [123],
"sizes": "<string>"
} }
}
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({
sort_order_code: '<string>',
dynamicLinking: {products: [{}], offset: 123},
defaultSelectedOptions: [{optionCode: '<string>', value: '<string>'}],
attributes: ['<string>'],
filter_group: {},
pagination: {page: 123, limit: 123},
facets: ['<string>'],
retrieveFacetCount: true,
includeFacetRanges: true,
enrichFacetMetaobjects: true,
discountEntitlements: [
{
entitled: {
all: true,
products: ['<string>'],
variants: [{}],
collections: ['<string>'],
conditions: {}
},
discount: {type: '<string>', value: 123}
}
],
identity: {
deviceId: '<string>',
sessionId: '<string>',
customerId: '<string>',
companyLocationId: '<string>'
},
preview_id: '<string>',
forceHideOutOfStock: true,
grid: {columns: 123, device: '<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: {}
},
responseOptions: {mediaPreloads: {enabled: true, srcsetSizes: [123], sizes: '<string>'}}
})
};
fetch('https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}', 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/browse/{collection_handle}",
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([
'sort_order_code' => '<string>',
'dynamicLinking' => [
'products' => [
[
]
],
'offset' => 123
],
'defaultSelectedOptions' => [
[
'optionCode' => '<string>',
'value' => '<string>'
]
],
'attributes' => [
'<string>'
],
'filter_group' => [
],
'pagination' => [
'page' => 123,
'limit' => 123
],
'facets' => [
'<string>'
],
'retrieveFacetCount' => true,
'includeFacetRanges' => true,
'enrichFacetMetaobjects' => true,
'discountEntitlements' => [
[
'entitled' => [
'all' => true,
'products' => [
'<string>'
],
'variants' => [
[
]
],
'collections' => [
'<string>'
],
'conditions' => [
]
],
'discount' => [
'type' => '<string>',
'value' => 123
]
]
],
'identity' => [
'deviceId' => '<string>',
'sessionId' => '<string>',
'customerId' => '<string>',
'companyLocationId' => '<string>'
],
'preview_id' => '<string>',
'forceHideOutOfStock' => true,
'grid' => [
'columns' => 123,
'device' => '<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' => [
]
],
'responseOptions' => [
'mediaPreloads' => [
'enabled' => true,
'srcsetSizes' => [
123
],
'sizes' => '<string>'
]
]
]),
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/browse/{collection_handle}"
payload := strings.NewReader("{\n \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\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/browse/{collection_handle}")
.header("X-Storefront-Access-Token", "<x-storefront-access-token>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.body("{\n \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}")
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 \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyPOST /storefront/v1/browse/summer-collection
{
"sort_order_code": "best-sellers",
"pagination": {
"page": 1,
"limit": 20
},
"retrieveFacetCount": true,
"facets": ["vendor", "product_type"],
"context": {
"geo": {
"country": "US",
"province": "California"
},
"marketing": {
"source": "google",
"medium": "cpc",
"campaign": "summer-sale"
},
"shoppingChannel": "web"
},
"identity": {
"sessionId": "abc123",
"deviceId": "device-uuid"
}
}
{
"results": [
{
"id": 7003338965178,
"title": "SUPREME SEALLINE SEE POUCH SMALL",
"body_html": "The Supreme Sealline See Pouch Small is a versatile and waterproof storage solution that seamlessly marries utility and style. With its clear window for easy visibility and the iconic Supreme branding, it's a sought-after accessory for those who appreciate keeping their essentials dry while making a fashion statement, whether at the beach or in the city..",
"vendor": "SUPREME",
"product_type": "Accessories",
"created_at": "2022-02-05T01:22:05.000000Z",
"handle": "supreme-pouch-44370ss18a32-sm",
"updated_at": "2023-10-25T20:47:04.000000Z",
"published_at": "2022-02-05T01:22:05.000000Z",
"tags": [
"consignment"
],
"images": [
{
"alt": "SUPREME POUCH",
"src": "https://cdn.shopify.com/s/files/1/0588/3677/9194/products/ss18_supreme_tnf_pouch_blk_2-l_5fb1316e-22f7-4702-9953-57f3fbdda5be.jpg?v=1644047927",
"width": 800,
"height": 534,
"variant_ids": []
}
],
"metafields": {
"product": {
"alias": "SEALLINE SEE POUCH SMALL",
"colorway": "BLACK",
"styleCode": "SS18A30 BLACK",
"yearOfRelease": 2018,
"searchColor": [
"black"
]
}
},
"available": true,
"price_range": {
"from": 30,
"to": 30
}
}
],
"totalResults": 1000,
"page": 1,
"totalPages": 20,
"facets": {
"vendor": {
"ADIDAS": 30,
"JORDAN": 336,
"NEW BALANCE": 15,
"NIKE": 384,
"REEBOK": 4,
"SUPREME": 624,
"VANS": 32
}
},
"attributionToken": "01JRVX8M3N4P5Q6R7S8T9U0V1W",
"_meta": {
"appliedRules": [],
"appliedSearchRules": [],
"appliedSearchRuleActions": []
},
"_workflow": [
{
"type": "rule-applied",
"payload": "rule_01JRVX8M3N4P5Q6R7S8T9U0V1W"
}
]
}
Browse
Browse API: Browse Collection Page
Browse API endpoint to fetch, filter, sort, and paginate merchandised collection pages in your catalog with facets, pins, and personalization applied.
POST
/
browse
/
{collection_handle}
Browse API: Browse Collection Page
curl --request POST \
--url https://app.uselayers.com/api/storefront/v1/browse/{collection_handle} \
--header 'Accept: <accept>' \
--header 'Content-Type: <content-type>' \
--header 'X-Storefront-Access-Token: <x-storefront-access-token>' \
--data '
{
"sort_order_code": "<string>",
"dynamicLinking": {
"products": [
{}
],
"offset": 123
},
"defaultSelectedOptions": [
{
"optionCode": "<string>",
"value": "<string>"
}
],
"attributes": [
"<string>"
],
"filter_group": {},
"pagination": {
"page": 123,
"limit": 123
},
"facets": [
"<string>"
],
"retrieveFacetCount": true,
"includeFacetRanges": true,
"enrichFacetMetaobjects": true,
"discountEntitlements": [
{
"entitled": {
"all": true,
"products": [
"<string>"
],
"variants": [
{}
],
"collections": [
"<string>"
],
"conditions": {}
},
"discount": {
"type": "<string>",
"value": 123
}
}
],
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"preview_id": "<string>",
"forceHideOutOfStock": true,
"grid": {
"columns": 123,
"device": "<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": {}
},
"responseOptions": {
"mediaPreloads": {
"enabled": true,
"srcsetSizes": [
123
],
"sizes": "<string>"
}
}
}
'import requests
url = "https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}"
payload = {
"sort_order_code": "<string>",
"dynamicLinking": {
"products": [{}],
"offset": 123
},
"defaultSelectedOptions": [
{
"optionCode": "<string>",
"value": "<string>"
}
],
"attributes": ["<string>"],
"filter_group": {},
"pagination": {
"page": 123,
"limit": 123
},
"facets": ["<string>"],
"retrieveFacetCount": True,
"includeFacetRanges": True,
"enrichFacetMetaobjects": True,
"discountEntitlements": [
{
"entitled": {
"all": True,
"products": ["<string>"],
"variants": [{}],
"collections": ["<string>"],
"conditions": {}
},
"discount": {
"type": "<string>",
"value": 123
}
}
],
"identity": {
"deviceId": "<string>",
"sessionId": "<string>",
"customerId": "<string>",
"companyLocationId": "<string>"
},
"preview_id": "<string>",
"forceHideOutOfStock": True,
"grid": {
"columns": 123,
"device": "<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": {}
},
"responseOptions": { "mediaPreloads": {
"enabled": True,
"srcsetSizes": [123],
"sizes": "<string>"
} }
}
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({
sort_order_code: '<string>',
dynamicLinking: {products: [{}], offset: 123},
defaultSelectedOptions: [{optionCode: '<string>', value: '<string>'}],
attributes: ['<string>'],
filter_group: {},
pagination: {page: 123, limit: 123},
facets: ['<string>'],
retrieveFacetCount: true,
includeFacetRanges: true,
enrichFacetMetaobjects: true,
discountEntitlements: [
{
entitled: {
all: true,
products: ['<string>'],
variants: [{}],
collections: ['<string>'],
conditions: {}
},
discount: {type: '<string>', value: 123}
}
],
identity: {
deviceId: '<string>',
sessionId: '<string>',
customerId: '<string>',
companyLocationId: '<string>'
},
preview_id: '<string>',
forceHideOutOfStock: true,
grid: {columns: 123, device: '<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: {}
},
responseOptions: {mediaPreloads: {enabled: true, srcsetSizes: [123], sizes: '<string>'}}
})
};
fetch('https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}', 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/browse/{collection_handle}",
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([
'sort_order_code' => '<string>',
'dynamicLinking' => [
'products' => [
[
]
],
'offset' => 123
],
'defaultSelectedOptions' => [
[
'optionCode' => '<string>',
'value' => '<string>'
]
],
'attributes' => [
'<string>'
],
'filter_group' => [
],
'pagination' => [
'page' => 123,
'limit' => 123
],
'facets' => [
'<string>'
],
'retrieveFacetCount' => true,
'includeFacetRanges' => true,
'enrichFacetMetaobjects' => true,
'discountEntitlements' => [
[
'entitled' => [
'all' => true,
'products' => [
'<string>'
],
'variants' => [
[
]
],
'collections' => [
'<string>'
],
'conditions' => [
]
],
'discount' => [
'type' => '<string>',
'value' => 123
]
]
],
'identity' => [
'deviceId' => '<string>',
'sessionId' => '<string>',
'customerId' => '<string>',
'companyLocationId' => '<string>'
],
'preview_id' => '<string>',
'forceHideOutOfStock' => true,
'grid' => [
'columns' => 123,
'device' => '<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' => [
]
],
'responseOptions' => [
'mediaPreloads' => [
'enabled' => true,
'srcsetSizes' => [
123
],
'sizes' => '<string>'
]
]
]),
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/browse/{collection_handle}"
payload := strings.NewReader("{\n \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\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/browse/{collection_handle}")
.header("X-Storefront-Access-Token", "<x-storefront-access-token>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.body("{\n \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uselayers.com/api/storefront/v1/browse/{collection_handle}")
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 \"sort_order_code\": \"<string>\",\n \"dynamicLinking\": {\n \"products\": [\n {}\n ],\n \"offset\": 123\n },\n \"defaultSelectedOptions\": [\n {\n \"optionCode\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"attributes\": [\n \"<string>\"\n ],\n \"filter_group\": {},\n \"pagination\": {\n \"page\": 123,\n \"limit\": 123\n },\n \"facets\": [\n \"<string>\"\n ],\n \"retrieveFacetCount\": true,\n \"includeFacetRanges\": true,\n \"enrichFacetMetaobjects\": true,\n \"discountEntitlements\": [\n {\n \"entitled\": {\n \"all\": true,\n \"products\": [\n \"<string>\"\n ],\n \"variants\": [\n {}\n ],\n \"collections\": [\n \"<string>\"\n ],\n \"conditions\": {}\n },\n \"discount\": {\n \"type\": \"<string>\",\n \"value\": 123\n }\n }\n ],\n \"identity\": {\n \"deviceId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"companyLocationId\": \"<string>\"\n },\n \"preview_id\": \"<string>\",\n \"forceHideOutOfStock\": true,\n \"grid\": {\n \"columns\": 123,\n \"device\": \"<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 \"responseOptions\": {\n \"mediaPreloads\": {\n \"enabled\": true,\n \"srcsetSizes\": [\n 123\n ],\n \"sizes\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyPOST /storefront/v1/browse/summer-collection
{
"sort_order_code": "best-sellers",
"pagination": {
"page": 1,
"limit": 20
},
"retrieveFacetCount": true,
"facets": ["vendor", "product_type"],
"context": {
"geo": {
"country": "US",
"province": "California"
},
"marketing": {
"source": "google",
"medium": "cpc",
"campaign": "summer-sale"
},
"shoppingChannel": "web"
},
"identity": {
"sessionId": "abc123",
"deviceId": "device-uuid"
}
}
{
"results": [
{
"id": 7003338965178,
"title": "SUPREME SEALLINE SEE POUCH SMALL",
"body_html": "The Supreme Sealline See Pouch Small is a versatile and waterproof storage solution that seamlessly marries utility and style. With its clear window for easy visibility and the iconic Supreme branding, it's a sought-after accessory for those who appreciate keeping their essentials dry while making a fashion statement, whether at the beach or in the city..",
"vendor": "SUPREME",
"product_type": "Accessories",
"created_at": "2022-02-05T01:22:05.000000Z",
"handle": "supreme-pouch-44370ss18a32-sm",
"updated_at": "2023-10-25T20:47:04.000000Z",
"published_at": "2022-02-05T01:22:05.000000Z",
"tags": [
"consignment"
],
"images": [
{
"alt": "SUPREME POUCH",
"src": "https://cdn.shopify.com/s/files/1/0588/3677/9194/products/ss18_supreme_tnf_pouch_blk_2-l_5fb1316e-22f7-4702-9953-57f3fbdda5be.jpg?v=1644047927",
"width": 800,
"height": 534,
"variant_ids": []
}
],
"metafields": {
"product": {
"alias": "SEALLINE SEE POUCH SMALL",
"colorway": "BLACK",
"styleCode": "SS18A30 BLACK",
"yearOfRelease": 2018,
"searchColor": [
"black"
]
}
},
"available": true,
"price_range": {
"from": 30,
"to": 30
}
}
],
"totalResults": 1000,
"page": 1,
"totalPages": 20,
"facets": {
"vendor": {
"ADIDAS": 30,
"JORDAN": 336,
"NEW BALANCE": 15,
"NIKE": 384,
"REEBOK": 4,
"SUPREME": 624,
"VANS": 32
}
},
"attributionToken": "01JRVX8M3N4P5Q6R7S8T9U0V1W",
"_meta": {
"appliedRules": [],
"appliedSearchRules": [],
"appliedSearchRuleActions": []
},
"_workflow": [
{
"type": "rule-applied",
"payload": "rule_01JRVX8M3N4P5Q6R7S8T9U0V1W"
}
]
}
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 handle of the collection you wish to browse.Use
all to browse every browsable product in the catalog. This works whether or not your store has a synced /collections/all collection. If a collection with the handle all is synced, Layers browses that collection’s products. If not, it browses the whole catalog with the store’s default sort order and no collection-specific variant breakouts. Any other handle that doesn’t match a synced collection returns an error.Body
string
Code of the sort order. When provided, it takes precedence over collection and store defaults. If omitted, Layers uses the collection’s default sort order, then the store default when the collection has no default. Existing merchandising rules continue to apply as configured.
object
Dynamic linking promotes specific products to the top of the first page of results. Dynamic linking takes priority over merchandising rules and sort orders.
If the Layers tracking pixel is installed, this parameter is automatically injected when customers arrive with a
utm_products URL parameter (e.g., ?utm_products=summer-dress-blue_classic-tee-white_beach-hat). See Dynamic Linking for ads for details.Show Properties
Show Properties
array
required
Products to pin. Each entry is either a plain identifier or an object:Example with explicit positions: pins
- Handle: a string, for example
"summer-dress-blue". - ID: a number or numeric string, for example
8234567890123. - Object:
{ "productId": "summer-dress-blue", "position": 2 }.productIdtakes a handle or ID.positionis optional.
productId, an empty string, a nested array) returns 422.Position:- Plain identifiers, and objects without
position, are pinned in array order: the first one at position 1 (after anyoffset), the next at position 2, and so on. - An object’s
positionis the exact 1-based slot for that product on the first page. It must be an integer of1or more, andoffsetdoesn’t apply to it. - Unpositioned products fill the remaining pinned slots in array order.
- If the same product appears more than once, the first explicit
positionfor it wins.
- Only applies on the first page of results (page 1)
- Non-existent or unavailable products are silently skipped
- Subsequent products shift up to fill any gaps
- Takes priority over merchandising rules and sort orders
{
"dynamicLinking": {
"products": ["summer-dress-blue", 8234567890123, "classic-tee-white"]
}
}
classic-tee-white to position 1 and summer-dress-blue to position 4.{
"dynamicLinking": {
"products": [
{ "productId": "summer-dress-blue", "position": 4 },
{ "productId": "classic-tee-white", "position": 1 }
]
}
}
integer
Number of leading positions to leave to the normal result order before the linked products. Defaults to
0, which pins the first product at position 1. An offset of 2 places the first linked product at position 3. Products with an explicit position ignore offset.Example:{
"dynamicLinking": {
"products": ["summer-dress-blue", "classic-tee-white"],
"offset": 2
}
}
array
Specify which product variants should be selected by default in the
Behavior:Multiple options example (OR logic):This will select variants with either February OR March birthstone, preferring the first match found.
first_or_matched_variant field. This is useful for scenarios like defaulting to a specific birthstone option in a jewelry collection.Show Properties
Show Properties
- Uses OR logic - selects the first variant matching ANY of the specified option values
- Falls back to the first variant by position if no match is found
- Automatically skipped when any option or variant filters are applied (filters take precedence)
- Only affects the
first_or_matched_variantfield in the response - Works with Variant Breakouts — product tiles respect your default selected options, and variant tiles respect non-breakout default selected options (preferring variants that match your preferences within each breakout group, with fallback to position ordering)
{
"defaultSelectedOptions": [
{
"optionCode": "birthstone",
"value": "February"
}
]
}
{
"defaultSelectedOptions": [
{
"optionCode": "birthstone",
"value": "February"
},
{
"optionCode": "birthstone",
"value": "March"
}
]
}
string[]
Product attributes to include in the response. By default, all attributes are included except opt-in attributes noted below. Available attributes include:
id, title, handle, body_html, vendor, product_type, tags, images, available, created_at, updated_at, published_at, price_range, options, original_options, metafields, named_tags, calculated, category, featured_media, is_gift_card, has_variants_that_require_components, combined_listing_parent_product_id, combined_listing_role, first_or_matched_variant, and variants. The collection_titles attribute is opt-in: pass it in attributes to include the array of collection titles each product belongs to. It is excluded from responses by default. See the Product Schema for detailed descriptions, including nested field selection for slicing arrays and filtering collections (for example, images[:2].src, variants[sku=ABC].price, metafields[namespace=custom]).object
Storefront endpoints accept nested
AND/OR filter groups up to two levels deep. Each nested group must contain at least one expression; empty nested groups are rejected. Metafield filter properties may include hyphens in their namespace or key, for example metafields.my-app.fit-type.Refer to the dedicated Filter Expressions guide to learn more about filter expressions.Pagination Object
string[]
Facets to be included. Accepts both exact facet codes (e.g.,
"vendor", "options.Size") and wildcard patterns (e.g., "options.*", "metafields.product.*").Wildcard patterns expand to all matching attribute codes. For example, "options.*" expands to all option facets like "options.Size" and "options.Color". Wildcards must match at least one attribute code to be valid.Examples:// Exact facet codes
"facets": ["vendor", "options.Size", "options.Color"]
// Wildcard pattern
"facets": ["options.*"]
// Mixed exact and wildcard
"facets": ["vendor", "options.*", "metafields.product.*"]
boolean
If the count of each facet value should be calculated.
boolean
If you want a min/max range for numeric facets such as price.
boolean
When
true, any facet backed by a metaobject_reference or list.metaobject_reference metafield is returned with a companion facetDisplay object. Each entry maps a facet value (the metaobject handle) to the referenced metaobject’s display_name and fields. When the metaobject defines a color or image field, the entry also carries a resolved swatch object.Use this when your storefront filter UI needs human-readable labels or nested field data (for example, a color name or swatch hex) instead of the raw handle. When false or omitted, only the handles are returned in facets.Values are looked up from the local metaobject cache. Handles with no matching cached metaobject are omitted from facetDisplay and remain as plain values in facets. See Metaobjects and reference metafields for the normalized shape of each entry.array
Apply discounts to products, variants, or collections. When provided, price-based sorting and filtering will use discounted prices. See the Discount Entitlements guide for detailed usage.Fixed amounts use your shop’s base currency. Layers skips them on market pricing rows in a different native currency, without converting the discount. Percentage discounts still apply to those localized prices. A variant that falls back to its base price can still receive a fixed-amount discount.
Show Discount Entitlement Object
Show Discount Entitlement Object
object
required
Defines which products qualify for the discount.
Show entitled
Show entitled
boolean
When
true, applies discount to all products. When false, uses products, variants, or collections arrays.string[]
Array of product IDs or handles that qualify for the discount. Maximum 250 entries.
string[] | number[]
Array of variant IDs that qualify for the discount. Maximum 250 entries.
string[]
Array of collection handles that qualify for the discount. Maximum 250 entries.
object
Optional filter group that qualifies products for the discount based on their attributes (for example,
tags or vendor). Uses the same shape as the top-level filter_group parameter. Matches are additive with products, variants, and collections on the same entitlement.object
required
Defines the discount to apply.
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.string
When provided, the Browse API loads the specified preview rule instead of the collection’s active merchandising rule. Preview rules are temporary and expire one hour after creation.This parameter is automatically included when you open a preview URL from the Layers dashboard. You do not need to set it manually in production integrations.Behavior:
- Overrides normal merchandising rule resolution for this request
- Analytics and beacon events are not recorded for preview requests
- Returns a
404if the preview has expired or does not exist
boolean
default:"false"
When set to
true, products with no available variants are excluded from results regardless of the store-level out-of-stock visibility setting. If your store’s inventory location scope is narrowed, the same location rules apply.This is useful when a specific browse integration or page requires strict in-stock filtering even though the store default allows out-of-stock products to appear.Store-level out-of-stock demoting (the “At the end” option) does not apply to browse results. Browse relies on the Shopify collection itself for product ordering. When you set
forceHideOutOfStock to true on a browse request, out-of-stock products are hidden entirely rather than demoted.object
Declares the storefront grid so inline merchandising banners can reserve grid cells and products are paged around them. When
Behavior:
grid is present, the response includes a top-level grid block and each anchored inline banner gets a page-local placement object.Omit grid to keep the legacy behavior. Banners return without placement, and pagination is computed against products only.Show Properties
Show Properties
integer
required
Number of columns in your product grid. Must be between
1 and 12. Inline banner widths are clamped to [1, columns] and heights to [1, 4]. When pagination.limit >= columns, height is also limited to the number of rows per page (floor(pagination.limit / columns)).string
default:"desktop"
"desktop" or "mobile". Selects which per-device layout (web_layout or mobile_layout) the planner reads when anchoring banners to grid cells.cellsPerPage = floor(pagination.limit / columns) * columns. Any remainder is dropped so pages are always whole rows.- Banners taller than one row cannot straddle a page’s last row; they move forward to the next open block.
- When two banners target the same cell, the second is bumped to the next open cell (row-major scan).
- Banners that cannot be anchored to the grid (missing device layout, no saved
position, or no fit within the scan buffer) are still returned, but without aplacementkey. totalPagesaccounts for banner cells across the collection, not just product count.
{
"pagination": { "page": 1, "limit": 24 },
"grid": {
"columns": 4,
"device": "desktop"
}
}
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.
object
Per-request overrides for response behavior. Currently controls image preload hints emitted in the
Example:
Link response header. You can disable preloads or narrow the srcset to the breakpoints your storefront uses. You cannot enable preloads when the store has them disabled.Show Properties
Show Properties
object
Controls the
Link: rel=\"preload\" directives generated for product images in this response. See Early hints for background.Show Properties
Show Properties
boolean
default:"true"
Set to
false to skip the Link header for this request. Useful for server-rendered pages that do not benefit from preload hints, or when you want to reduce response header size. Cannot enable preloads if they are disabled at the store level.int[]
Custom responsive image widths (in pixels) to emit in
imagesrcset. Each value must be an integer between 1 and 10000. Overrides the store-level srcset configuration for this request only. When omitted, the store configuration or platform defaults are used.string
Media query string emitted as the
imagesizes attribute in the preload Link header (for example (max-width: 600px) 100vw, 50vw). Tells the browser which srcset width to pick per viewport. Overrides the store-level sizes value for this request only. When omitted or empty, the store configuration is used. Each comma-separated entry may carry a media condition, including the last entry. See the accepted format for details. The API rejects invalid values with a validation error.{
"responseOptions": {
"mediaPreloads": {
"enabled": true,
"srcsetSizes": [320, 640, 960],
"sizes": "(max-width: 600px) 100vw, 50vw"
}
}
}
Response
Array of Objects
Show Properties
Show Properties
number
The unique identifier of the product.
string
The title of the product.
string
The HTML content describing the product.
string
The vendor of the product.
string
The type of the product.
number
The timestamp when the product was created.
string
The handle of the product.
number
The timestamp when the product was updated.
number
The timestamp when the product was published.
Array of strings
The tags associated with the product.
number
The parent product id if a child in a Combined Listing.
string
The role of the product if part of a Combined Listing.
Array of Objects
Object
The metafields of the product.
Object
The computed attributes of the product. Only includes attributes with non-null, non-empty values. Attributes that evaluate to null or an empty string are omitted.
Object
Object
The first available variant (depending on OOS settings) or the variant matched with a filter or search query.
Show Properties
Show Properties
number
The ID of the variant.
string
The title of the variant.
boolean
The availability of the variant.
number
The sku of the variant.
string
The price of the variant.
string
The compare at price of the variant.
Object
The metafields of the variant.
Array of Objects
number
The position of the variant in the product’s variant list.
number
Total inventory quantity across the locations in the store’s inventory location scope, which is all locations by default. Only included when the store has the Expose Variant Inventory setting enabled.
string
Inventory policy for the variant:
DENY (stop selling when out of stock) or CONTINUE (allow overselling). Only included when the store has the Expose Variant Inventory setting enabled.object
Object mapping location IDs to available inventory quantities (e.g.,
{"1001": 5, "1002": 10}). Returns empty object {} when no inventory data exists. Only included when the store has the Expose Variant Inventory setting enabled.Object
boolean
The availability of the product.
number
The total number of results. When variant breakouts are enabled, this reflects the count of tiles (both product and variant tiles) rather than just products.The count is scoped to the visibility of the active shopping channel. When
context.shoppingChannel is "web" (the default), only products published to the online store are counted. When it is "app" and an app sales channel is configured, only products published to that channel are counted. As a result, totalResults always matches the number of products a shopper can actually see for that channel.number
The current page number.
number
The total number of pages. Calculated based on tile count when variant breakouts are enabled.
object
If
retrieveFacetCount is true then an object with keys and values of the specified attributes. When variant breakouts are enabled, facet counts reflect tile counts rather than product counts. Empty values and literal "null" strings are automatically excluded from facet results.Counts are scoped to the visibility of the active shopping channel, so they match the number of products (or tiles) a shopper can actually see. Products that are not published to the requester’s channel, are B2B-only, or are hidden by a combined-listing role are excluded from every bucket. When context.shoppingChannel is "app" but the store does not have an app sales channel configured, counts fall back to the web channel.When filter_group is present, counts follow the standard “OR within a facet, AND across facets” pattern. Facets whose condition uses a multi-select operator (IN, NOT IN) are counted against every other active filter except the facet’s own, so other values in the same facet stay selectable. Facets whose condition uses a single-select or predicate operator (EQ, NEQ, GT, LT, BETWEEN, NULL, and so on) are counted against the fully filtered result set.object
If
includeFacetRanges is true then an object with keys of the facet attribute code and value is an object with min/max.object
Returned when at least one requested facet has display data to hydrate. Keys are facet attribute codes; values map each facet value to a display object.Metaobject-reference facets require
enrichFacetMetaobjects: true and map each handle to the metaobject’s display_name and fields. Entries also carry a swatch object when the metaobject defines a color or image field. Handles with no matching cached metaobject are omitted here and remain as plain values in facets. See Metaobjects and reference metafields for the normalized field shape and the Facets API response for the swatch shape.For variants.pickup_locations, each entry maps a Shopify location id to the location’s id, name, address, instructions, pickupTime, and (when the filter is a geoRadius) distance and distanceUnit. Pickup entries are returned whenever pickup facets are requested, regardless of enrichFacetMetaobjects. See Local pickup filtering.array of objects
Merchandising banners emitted by any merchandising rules that matched this request. Flat across all applied rules and pre-sorted by
sort_index. Your storefront is responsible for rendering banners into the grid. See Rendering banners in Liquid and Rendering banners with the SDK. Each banner carries the rule_id of the rule that produced it. _meta.appliedRules still lists every applied rule ID.Show Properties
Show Properties
string
Banner ULID.
string | null
ID of the merchandising rule that produced this banner. Send it on
banner_impression and banner_click tracking events so engagement attributes back to the rule.string
Internal name (not shown to shoppers).
string
"inject" or "overtake". inject inserts the banner at position and shifts trailing products; overtake replaces the product at position.string | null
Click-through URL. Only honored on
inject banners, and only meaningful when type is "link" (the built-in type). Custom banner types put their click-through URL inside data instead.string
Banner type slug.
"link" for the built-in type, otherwise the slug of a custom banner type defined for your store. Storefronts switch renderers on this value.object
Saved values for the banner type’s field schema. Keys match the schema’s
key values. Only keys defined in the current schema are returned. Retyped or removed fields are dropped. product_reference, collection_reference, and variant_reference fields (and their list. variants) are resolved to { "id", "handle" } objects; unpublished references are omitted.number
Application order when a rule has multiple banners. Lower wins on conflicting cells.
object
Desktop media.
{ id, src, alt, width, height, source, mediaContentType }. source is "store_file" today and mediaContentType is "IMAGE" today.object
Mobile media. Same shape as
web_media.object
Desktop layout.
{ placement: "hero" | "inline", width, height, position }. For hero, render a horizontal banner across the full product-grid width above the first product row; ignore the cell spans and position. For inline, position is a row-major 0-indexed grid cell, and width and height are column and row spans, not image dimensions in pixels. Inline width is bounded by the grid columns, not limited to one or two; inline banners can span up to four rows, and the editor resizes both width and height.object
Mobile layout. Same shape as
web_layout.object
Only present when the request includes a
grid block and the banner is an inline banner anchored to a cell on the current page. Hero banners never carry placement and are always returned. Inline banners that could not be anchored (missing device layout, no saved position, or no fit within the scan buffer) are still returned without this key so they do not vanish from the storefront.Show Properties
Show Properties
number
The 1-indexed page this placement is anchored to. Always matches the requested
pagination.page.number
0-indexed row within the current page.
number
0-indexed column where the banner starts. Combined with
colSpan, gives the CSS grid-column: colStart + 1 / span colSpan.number
Number of columns the banner spans. Clamped to
[1, grid.columns].number
Number of rows the banner spans. Clamped to
[1, 4] and, when pagination.limit >= grid.columns, to the number of rows per page.object
Only present when the request includes a
grid block. Echoes the resolved grid geometry so the storefront can render banners into the exact cells the planner used to page products.Show Properties
Show Properties
number
Column count from the request.
string
"desktop" or "mobile", from the request.number
Total grid cells on this page, equal to
floor(pagination.limit / columns) * columns.number
Number of full rows on this page.
number
How many of
cellsPerPage are occupied by inline banner placements. The remaining cells hold the products in results.string
A unique request identifier (ULID) for this API call. Use this token to correlate browse requests with analytics events via the Beacon API, and to match requests to entries in the Search Inspector.
object
Show Properties
Show Properties
Array of strings
The merchandising rule IDs applied to the request.
Array of strings
The IDs of request transforms whose targeting conditions matched this request. Returns an empty array when no request transforms matched. Use this to verify which request transforms are evaluating against a given browse request.
array of objects
One entry per action executed by a matched request transform, in execution order. Use
changed to tell whether an action actually modified the request. A matched rule can appear in appliedSearchRules while all of its actions report changed: false. See Debugging with _meta.Show Properties
Show Properties
string
The ID of the request transform that owns the action.
string
The action type, for example
add_filter_group or override_sort_order.boolean
true when the action modified the request. false when the action was a no-op, for example an override_sort_order action matching the already-active sort order.string
Only present when the action could not run.
"unsupported_action_type" indicates a stored action type the engine cannot execute. The action is skipped and the rest of the request proceeds normally.array of objects
Array of variant breakout configurations applied to this collection. Only present when one or more variant breakouts are active for the collection. Multiple breakouts with different option codes can work simultaneously in the same collection. Each object has the structure
{optionCode: "Stone"}.Show Properties
Show Properties
string
The product option code that determines which variants are broken out (e.g., “Stone”, “Color”). Each product is broken out by the first matching option code from the array.
object
Echoes the image preload configuration used to build the
Link response header for this request. Only present when image preloads are emitted. See Early hints.Show Properties
Show Properties
int[]
The responsive image widths (in pixels) used in the
imagesrcset of the Link header. Reflects the request override when provided, otherwise the store-level configuration or platform defaults.array of objects
Echoes the discount entitlements applied to this request. Only present when the request included
discountEntitlements (either directly or via a matched request transform). Use this to render discount badges or labels on the storefront without re-deriving which entitlements matched. Each entry mirrors the entitlement shape sent in the request.Show Properties
Show Properties
object
The entitlement criteria that qualified products for the discount. Contains any of
all, products, variants, collections, or conditions. See the entitlement criteria reference.object
The discount Layers applied.
Show Properties
Show Properties
array of objects
An ordered trace of processing steps the engine performed to produce results for this request. Each entry represents a stage in the browse pipeline, recorded in the order it was executed. Use this field to understand which merchandising rules, sort orders, and boosts were applied.This field is useful for debugging browse behavior in development and is also surfaced in the Search Inspector panel.
Show Properties
Show Properties
string
The processing step type. Possible values include:
"rule-applied"— A merchandising rule was applied. Thepayloadcontains the rule identifier."ranking-rules"— Ranking rules influenced result ordering.
string | array | object
The data associated with this processing step. The structure varies by
type.Response headers
Every API response includes the following headers for request tracing and performance optimization:| Header | Description |
|---|---|
x-request-id | A unique identifier (ULID) for the request. This matches the attributionToken in the response body. Use it to correlate requests across your infrastructure or when contacting support. |
x-layers-build | The Layers build version that served the request. |
X-Layers-Results-Cache | Indicates whether the response was served from the results cache. Returns HIT when cached results were used, or MISS when results were computed fresh. |
Link | Contains rel="preload" directives for product images in the response (up to 6 items), enabling browsers and CDNs to begin fetching images before your application processes the JSON body. See Early hints for configuration options. Only included when early hints are enabled (enabled by default). |
Variant breakouts
When variant breakouts are configured, results may include both product tiles and variant tiles. Each result includes a__typename field to identify the tile type:
string
Identifies the type of tile in the results:
"Product"- A standard product tile"Variant"- An individual variant tile from a product with a configured breakout option
Variant tile fields
Variant tiles include additional fields to identify the specific variant:number
The parent product ID. Use this to link back to the full product or group variants from the same product.
number
The specific variant ID. For variant tiles, this matches the
id field.For variant tiles, the
id field contains the variant ID (not the product ID). The title field is formatted as "{product title} - {option value}" by default (e.g., “Amethyst Ring - Rose Quartz”), but the format can be configured per breakout. If the breakout’s Include Option Value in Title setting is disabled, the title is the original product title. See the Variant Breakouts documentation for more details.POST /storefront/v1/browse/summer-collection
{
"sort_order_code": "best-sellers",
"pagination": {
"page": 1,
"limit": 20
},
"retrieveFacetCount": true,
"facets": ["vendor", "product_type"],
"context": {
"geo": {
"country": "US",
"province": "California"
},
"marketing": {
"source": "google",
"medium": "cpc",
"campaign": "summer-sale"
},
"shoppingChannel": "web"
},
"identity": {
"sessionId": "abc123",
"deviceId": "device-uuid"
}
}
{
"results": [
{
"id": 7003338965178,
"title": "SUPREME SEALLINE SEE POUCH SMALL",
"body_html": "The Supreme Sealline See Pouch Small is a versatile and waterproof storage solution that seamlessly marries utility and style. With its clear window for easy visibility and the iconic Supreme branding, it's a sought-after accessory for those who appreciate keeping their essentials dry while making a fashion statement, whether at the beach or in the city..",
"vendor": "SUPREME",
"product_type": "Accessories",
"created_at": "2022-02-05T01:22:05.000000Z",
"handle": "supreme-pouch-44370ss18a32-sm",
"updated_at": "2023-10-25T20:47:04.000000Z",
"published_at": "2022-02-05T01:22:05.000000Z",
"tags": [
"consignment"
],
"images": [
{
"alt": "SUPREME POUCH",
"src": "https://cdn.shopify.com/s/files/1/0588/3677/9194/products/ss18_supreme_tnf_pouch_blk_2-l_5fb1316e-22f7-4702-9953-57f3fbdda5be.jpg?v=1644047927",
"width": 800,
"height": 534,
"variant_ids": []
}
],
"metafields": {
"product": {
"alias": "SEALLINE SEE POUCH SMALL",
"colorway": "BLACK",
"styleCode": "SS18A30 BLACK",
"yearOfRelease": 2018,
"searchColor": [
"black"
]
}
},
"available": true,
"price_range": {
"from": 30,
"to": 30
}
}
],
"totalResults": 1000,
"page": 1,
"totalPages": 20,
"facets": {
"vendor": {
"ADIDAS": 30,
"JORDAN": 336,
"NEW BALANCE": 15,
"NIKE": 384,
"REEBOK": 4,
"SUPREME": 624,
"VANS": 32
}
},
"attributionToken": "01JRVX8M3N4P5Q6R7S8T9U0V1W",
"_meta": {
"appliedRules": [],
"appliedSearchRules": [],
"appliedSearchRuleActions": []
},
"_workflow": [
{
"type": "rule-applied",
"payload": "rule_01JRVX8M3N4P5Q6R7S8T9U0V1W"
}
]
}
Was this page helpful?