younifyd
Menu

List Searchable Fields

List searchable fields

GET/pcm/catalogs/searchable-fields

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Searchable Fields action (under Catalog Search).
  3. Fill in the fields below, then reference the result from later steps as {{listSearchableFields.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 {{listSearchableFields.response.data.<field>}}.

dataarray<object>

A collection of searchable fields.

idstringrequired

A unique identifier of the field.

typestringrequired

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

One ofcatalog_searchable_field

attributesobjectrequired5 fields
metaobjectrequired1 fields
metaobject
resultsobjectrequired1 fields

Contains the results for the entire collection.

json
{
  "data": [
    {
      "id": "name",
      "type": "catalog_searchable_field",
      "attributes": {
        "name": "name",
        "type": "string",
        "facetable": true,
        "sortable": true,
        "locale": "en"
      },
      "meta": {
        "owner": "organization"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 100
    }
  }
}

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