Search

Read and change the store's storefront search settings and rebuild its search index through the Store API.

Search settings turn storefront search and predictive search on or off and choose the result types search returns. They apply to every storefront in the store. Reads require read_search; changes require write_search. Send back the revision you read when you update, so a change made in the meantime is never overwritten.

The search index follows product, collection, page and other edits on its own. Rebuilding it re-indexes every searchable resource in every store language in the background; storefront search keeps answering from the current index while it runs, and only one rebuild runs at a time. Follow a rebuild with its job. Synonyms are managed under Search synonyms.

Endpoints#

Get search settings

GET read_search

Get the store's storefront search settings.

Returns whether storefront search and predictive search are on, the result types search returns, and revision: send it back when you update. options.result_types lists every selectable result type.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/search/settings' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/settings", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/search/settings",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"settings":{"revision":"2026-07-08T13:10:00.123456Z","search_enabled":true,"predictive_search_enabled":true,"search_result_types":["products","collections"]},"options":{"result_types":["products","collections","categories","vendors","brands","pages","blog_posts","blog_categories","policies"],"query_history_retention_days":90}}}

Update search settings

PUT write_search

Change the store's storefront search settings.

Send revision from Get search settings and at least one setting; omitted settings stay unchanged. search_result_types replaces the whole list; repeats count once. A save that changes nothing returns the current settings. A change made since revision was read returns SEARCH_SETTINGS_CHANGED_DURING_EDIT: read the settings again before saving.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`revision` required	`string`	`revision` from Get search settings. Example: `2026-07-08T13:10:00.123456Z`
`search_enabled`	`boolean`	Turn storefront search on or off. Example: `true`
`predictive_search_enabled`	`boolean`	Show suggestions while shoppers type. Example: `true`
`search_result_types`	`array<string>`	Result types storefront search returns, in any order. Allowed values `productscollectionscategoriesvendorsbrandspagesblog_postsblog_categoriespolicies` Example: `["products","collections"]`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The body has an unknown field or a field has the wrong type.
400 SEARCH_SETTINGS_REVISION_REQUIRED
revision is missing.
400 INVALID_INPUT
No setting was sent.
400 STOREFRONT_SEARCH_RESULT_TYPE_INVALID
A result type is not one of options.result_types.
409 SEARCH_SETTINGS_CHANGED_DURING_EDIT
The settings changed since revision was read.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/search/settings' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "predictive_search_enabled": true,
  "revision": "2026-07-08T13:10:00.123456Z",
  "search_enabled": true,
  "search_result_types": [
    "products",
    "collections"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/settings", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "predictive_search_enabled": true,
    "revision": "2026-07-08T13:10:00.123456Z",
    "search_enabled": true,
    "search_result_types": [
      "products",
      "collections"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/search/settings",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "predictive_search_enabled": True,
        "revision": "2026-07-08T13:10:00.123456Z",
        "search_enabled": True,
        "search_result_types": ["products", "collections"],
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"code":"SEARCH_SETTINGS_UPDATED","message":"Search settings saved.","data":{"settings":{"revision":"2026-07-08T13:10:00.123456Z","search_enabled":true,"predictive_search_enabled":true,"search_result_types":["products","collections"]},"options":{"result_types":["products","collections","categories","vendors","brands","pages","blog_posts","blog_categories","policies"],"query_history_retention_days":90}}}

Rebuild the search index

POST write_search

Rebuild the store's storefront search index.

Starts a background rebuild of every searchable resource in every store language and returns its job_id. Storefront search keeps answering from the current index while it runs. Only one rebuild runs at a time, and a store can start one rebuild per hour; follow it with Get a search index rebuild. A rebuild rewrites only documents whose content changed and removes documents for resources no longer shown. Product, page and other edits already reach the index on their own; a rebuild is for repairing it.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
409 SEARCH_REINDEX_IN_PROGRESS
A rebuild is already running.
429 SEARCH_REINDEX_COOLDOWN
A rebuild started less than an hour ago; the message says how many minutes remain.

curl -X POST 'https://api-store.tringify.com/api/2025-01/search/reindex' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/reindex", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/search/reindex",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"code":"SEARCH_REINDEX_QUEUED","message":"Search index rebuild started.","data":{"job_id":"7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83"}}

Search index rebuild limits

GET read_search

Get the rebuild list page sizes.

jobs_list_page_size is the default limit; jobs_list_max_limit is the largest accepted.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/search/jobs/limits' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/jobs/limits", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/search/jobs/limits",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"jobs_list_page_size":20,"jobs_list_max_limit":100,"jobs_page_size_options":[10,20,50,100]}}

List search index rebuilds

GET read_search

List the store's search index rebuilds, newest first.

Finished rebuilds are kept for a limited time. Each rebuild carries status_display, its status named in the request language (English by default). A failed rebuild carries failure_message with a support reference. completed_types of total_types resource types are done; document_count is the number of documents indexed so far.

Query parameters

Name	Type	Description
`limit`	`integer`	Page size, up to jobs_list_max_limit. Example: `20`
`offset`	`integer`	Number of rebuilds to skip. Default: `0` Example: `0`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/search/jobs?limit=20&offset=0' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/jobs?limit=20&offset=0", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/search/jobs?limit=20&offset=0",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"jobs":[{"id":"7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83","store_id":"b3ddaf1e-cb05-4c0f-8628-22015028325f","status":"processing","status_display":"Processing","total_types":9,"completed_types":4,"document_count":1840,"created_by":"2a1b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","started_at":"2026-07-08T18:40:00-04:00","completed_at":null,"failed_at":null,"created_at":"2026-07-08T18:40:00-04:00"}],"total":1}}

Get the running search index rebuild

GET read_search

Get the rebuild that is running now.

job is null when no rebuild is running.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/search/jobs/active' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/jobs/active", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/search/jobs/active",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"job":{"id":"7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83","store_id":"b3ddaf1e-cb05-4c0f-8628-22015028325f","status":"processing","status_display":"Processing","total_types":9,"completed_types":4,"document_count":1840,"created_by":"2a1b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","started_at":"2026-07-08T18:40:00-04:00","completed_at":null,"failed_at":null,"created_at":"2026-07-08T18:40:00-04:00"}}}

Get a search index rebuild

GET read_search

Get one search index rebuild.

status is processing, completed or failed; status_display names it in the request language (English by default).

Path parameters

Name	Type	Description
`job_id` required	`uuid`	Rebuild job id from Rebuild the search index or List search index rebuilds. Example: `7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
404 SEARCH_JOB_NOT_FOUND
No rebuild with this id exists for the store, or it is past retention.

curl 'https://api-store.tringify.com/api/2025-01/search/jobs/7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/search/jobs/7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/search/jobs/7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"job":{"id":"7d3e9a51-2c4b-4f6e-8a1d-9b0c2e4f6a83","store_id":"b3ddaf1e-cb05-4c0f-8628-22015028325f","status":"processing","status_display":"Processing","total_types":9,"completed_types":4,"document_count":1840,"created_by":"2a1b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","started_at":"2026-07-08T18:40:00-04:00","completed_at":null,"failed_at":null,"created_at":"2026-07-08T18:40:00-04:00"}}}