List Search Profiles

List search profiles

GET/pcm/catalogs/search-profiles

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the List Search Profiles action (under Catalog Search).
Fill in the fields below, then reference the result from later steps as {{listSearchProfiles.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://euwest.api.elasticpath.com/v2https://useast.api.elasticpath.com/v2__custom__Default "https://euwest.api.elasticpath.com/v2"

baseUrlCustomstring

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 200 with an object. Read it in later steps with {{listSearchProfiles.response.data.<field>}}.

dataarray<object>

idstring (uuid)required

The unique identifier for the search profile.

typestringrequired

Represents the type of object being returned. Always `catalog_search_profile`.

One ofcatalog_search_profile

attributesobjectrequired12 fields

metaobjectrequired2 fields

metaobject

resultsobjectrequired1 fields

Contains the results for the entire collection.

json

{
  "data": [
    {
      "id": "805103ff-0a37-4f83-8fe0-95a16039bd98",
      "type": "catalog_search_profile",
      "attributes": {
        "slug": "default",
        "description": "Default search profile",
        "fields": [
          {
            "name": "name",
            "weight": 10,
            "num_typos": 1,
            "prefix": true
          }
        ],
        "force_use_default_price_for_faceting_and_sorting": true,
        "text_match_type": "max_score",
        "filters": [
          "meta.search.categories.lvl1:=`All Products > Mens Shoes`"
        ],
        "exclusions": [
          "meta.search.categories.lvl1:=`All Products > Mens Shoes`"
        ],
        "boosts": [
          {
            "condition": "meta.search.nodes.name:=\\`Electronics\\`",
            "weight": 5
          }
        ],
        "prefix": true,
        "typo_tolerance": {
          "num_typos": 1,
          "min_len_to_allow_single_character_correction": 3,
          "min_len_to_allow_two_character_correction": 7,
          "typo_tokens_threshold": 1,
          "drop_tokens_threshold": 1,
          "drop_tokens_mode": "right_to_left",
          "enable_typos_for_numerical_tokens": true,
          "enable_typos_for_special_char_tokens": true,
          "split_join_tokens": "fallback"
        },
        "synonym_settings": {
          "demote_synonym_match": true,
          "synonym_resolution_allowed_on_prefix": true,
          "number_of_typos_allowed_when_resolving_synonyms": 0
        },
        "synonym_sets": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ]
      },
      "meta": {
        "default": true,
        "owner": "organization"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 100
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?