Error
A valid request URL is required to generate request examples{
"search_configuration": {
"vector_alpha": 123,
"query_by_fields": [
{
"field": "title",
"weight": 63
}
],
"filter_facets": [
{
"field": "colors",
"label": "<string>"
}
],
"out_of_stock_exempt_tags": [
"<string>"
],
"hide_out_of_stock_products": true,
"tenant_synonym_groups": [
[
"<string>"
]
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
Read the merchant's search relevance settings
Returns how storefront search ranks and filters for the merchant: keyword/meaning blend, searchable fields with weights, filter facets, sold-out handling and synonym groups. Unset values come back resolved to the serving defaults. Read-only. A 404 means the merchant has no Search section yet; the portal uses this read to decide whether to show it.
GET
/
search-config
/
configuration
Error
A valid request URL is required to generate request examples{
"search_configuration": {
"vector_alpha": 123,
"query_by_fields": [
{
"field": "title",
"weight": 63
}
],
"filter_facets": [
{
"field": "colors",
"label": "<string>"
}
],
"out_of_stock_exempt_tags": [
"<string>"
],
"hide_out_of_stock_products": true,
"tenant_synonym_groups": [
[
"<string>"
]
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The settings, defaults resolved.
Show child attributes
Show child attributes
Was this page helpful?