Read the search empty-state configuration

Error

A valid request URL is required to generate request examples

{
  "empty_state_config": {
    "sort_order": "CREATED_DESC",
    "pinned_main_product_ids": [
      "<string>"
    ],
    "generated_empty_state_suggestions": {},
    "localized_strings_overrides": {},
    "suggestion_blocked_terms": [
      "<string>"
    ],
    "suggestion_extra_instructions": "<string>"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

search-config

states

Error

A valid request URL is required to generate request examples

{
  "empty_state_config": {
    "sort_order": "CREATED_DESC",
    "pinned_main_product_ids": [
      "<string>"
    ],
    "generated_empty_state_suggestions": {},
    "localized_strings_overrides": {},
    "suggestion_blocked_terms": [
      "<string>"
    ],
    "suggestion_extra_instructions": "<string>"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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>.

Response

The empty-state configuration, defaults resolved.

empty_state_config

object

required

Show child attributes