Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

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

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

Body

application/json
sort_order
enum<string>

Order of the products shown before the shopper types.

Available options:
CREATED_DESC,
STOCK_DESC,
BESTSELLERS
hide_out_of_stock_products
boolean
pinned_main_product_ids
string[]

Numeric Shopify product ids pinned first in the empty state, in order.

Maximum array length: 6
generated_empty_state_suggestions
object

Per-locale suggestion chips shown before the shopper types; writing them marks them merchant-curated.

localized_strings_overrides
object

Per-locale storefront UI string overrides: {locale: {key: text}}.

search_configuration
object

Merged key by key into the stored configuration: omitted keys keep their value, and {} changes nothing.

suggestion_blocked_terms
string[]

Terms never offered as generated suggestions.

Maximum array length: 200
Required string length: 1 - 100
suggestion_extra_instructions
string | null

Extra guidance for the suggestion generator; null or blank clears it.

Maximum string length: 4000

Response

Saved. The body is JSON null.