v4

OpenAPI 3.1.02026-08-01166346466.7 KB
stores

Get a search rule

Get a search rule by ID.

Args: store_identifier: The ID or name of the store rule_id: The ID of the search rule to retrieve

Returns: SearchRuleResponse: The search rule details

get/v1/stores/{store_identifier}/rules/{rule_id}

Path parameters

string required
OR
string uuid required

The ID or name of the store

rule_idstring uuid required

The ID of the search rule

The ID of the search rule

Response

The search rule details

idstring required

The search rule ID

object'search_rule'

The object type

querystring required

The query pattern

store_idstring required

The store ID

created_atstring date-time required

When the rule was created

updated_atstring date-time required

When the rule was last updated

Example response

{
  "rules": [
    {
      "substitution": "query1"
    }
  ]
}