Autosuggest tools

list_autosuggest_exclusion_rules: List the autosuggest exclusion rules in an account.
get_autosuggest_exclusion_rule: Get the full detail of a single autosuggest exclusion rule.
get_autosuggest_results: Get the autosuggest suggestions for a search term.

list_autosuggest_exclusion_rules

Lists the autosuggest exclusion rules in an account. Exclusion rules keep specific keywords out of the autosuggest dropdown, so shoppers never see terms you want to hide.

The response gives you a paginated set of rule summaries, each with the rule name, excluded keywords, domain key, enabled status, and sync status. Use get_autosuggest_exclusion_rule when you need the full detail of one rule.

Request parameters

Name	Type	Required?	Description
`account_name`	`str \| null`	No	The account name. Required if you have access to more than one account.
`site_group_id`	`str \| int \| null`	No	A site group ID or site name. Defaults to the account level (`-1`).
`page`	`int`	No	The page number, zero-based. Defaults to `0`.
`limit`	`int`	No	The number of results per page. Defaults to `10`.
`sort_by`	`str`	No	The field to sort by, such as `MODIFIED_AT`, `CREATED_AT`, `RULE_NAME`, or `ENABLED`. Defaults to `MODIFIED_AT`.
`sort_order`	`str`	No	The sort direction, `ASC` or `DESC`. Defaults to `DESC`.
`q`	`str \| null`	No	A text search to filter rules by name, user, or keywords.

Response parameters

The tool returns an AutosuggestRulesResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[AutosuggestRule]`	The exclusion rules in the account.
`error`	`str \| null`	Error message if the request failed.

The AutosuggestRule object has the following fields:

Field	Type	Description
`id`	`int`	The rule's unique ID.
`accountId`	`int \| null`	The account this rule belongs to.
`domainKey`	`str \| null`	The domain key the rule applies to. A `null` value means account-wide.
`ruleName`	`str \| null`	The rule's display name.
`keywords`	`list[str]`	The keywords excluded from autosuggest.
`enabled`	`bool`	Whether the rule is enabled.
`note`	`str \| null`	An optional note, up to 255 characters.
`user`	`str \| null`	The user who last modified the rule.
`createdAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was created.
`modifiedAt`	`int \| null`	Unix timestamp in milliseconds of the last modification.
`deleted`	`bool \| null`	Whether the rule has been soft-deleted.
`deletedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was deleted.
`syncStatus`	`str \| null`	The sync status: `PENDING`, `IN_PROGRESS`, `SUCCESS`, or `FAILED`.

get_autosuggest_exclusion_rule

Returns the full detail of a single autosuggest exclusion rule, including its excluded keywords, domain key, enabled status, note, and sync status. Use list_autosuggest_exclusion_rules first to find the rule ID you want.

Request parameters

Name	Type	Required?	Description
`rule_id`	`int`	Yes	The rule ID returned by `list_autosuggest_exclusion_rules`.
`account_name`	`str \| null`	No	The account name. Required if you have access to more than one account.
`site_group_id`	`str \| int \| null`	No	A site group ID or site name. Defaults to the account level (`-1`).

Response parameters

The tool returns an AutosuggestRuleResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`AutosuggestRule \| null`	The full exclusion rule record.
`error`	`str \| null`	Error message if the request failed.

The AutosuggestRule object has the fields documented under list_autosuggest_exclusion_rules.

get_autosuggest_results

Returns the search terms that would appear in the autosuggest dropdown when a shopper starts typing a query. Use this to test how autosuggest behaves for a given term, confirm that your exclusion rules work, or explore what terms surface for a partial query.

Request parameters

Name	Type	Required?	Description
`q`	`str`	Yes	The search term to get suggestions for.
`domain_key`	`str \| null`	No	The domain key to query. Omit to use the merchant default.

Response parameters

The tool returns an AutosuggestSuggestionsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[str]`	The suggested search terms.
`error`	`str \| null`	Error message if the request failed.