younifyd
Menu

Update Indexable Fields

Update indexable fields

PUT/pcm/catalogs/indexable-fields/{indexable_fields_id}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Update Indexable Fields action (under Catalog Search).
  3. Fill in the fields below, then reference the result from later steps as {{updateIndexableFields.response.data}}.

Request

Path parameters

indexable_fields_idstring (uuid)required

The unique ID of the indexable fields

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
idstring (uuid)required

The unique identifier of the indexable fields. Must match the ID specified in the request path.

typestringrequired

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

One ofcatalog_search_indexable_fields

attributesobjectrequired4 fields
json
{
  "data": {
    "id": "805103ff-0a37-4f83-8fe0-95a16039bd98",
    "type": "catalog_search_indexable_fields",
    "attributes": {
      "fields": [
        {
          "name": "extensions.products(clothing).color",
          "facetable": false,
          "sortable": false,
          "locale": "en"
        },
        {
          "name": "shopper_attributes.fabric",
          "facetable": false,
          "sortable": false
        },
        {
          "name": "admin_attributes.internal_grade",
          "sortable": true
        }
      ],
      "core_field_overrides": [
        {
          "name": "name",
          "stem": true,
          "token_separators": [
            "string"
          ],
          "symbols_to_index": [
            "string"
          ],
          "sortable": true,
          "facetable": true
        }
      ],
      "token_separators": [
        "string"
      ],
      "symbols_to_index": [
        "string"
      ]
    }
  }
}

Response

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

dataobject
idstring (uuid)required

A unique identifier of the indexable fields.

typestringrequired

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

One ofcatalog_search_indexable_fields

attributesobjectrequired4 fields
metaobjectrequired1 fields
json
{
  "data": {
    "id": "805103ff-0a37-4f83-8fe0-95a16039bd98",
    "type": "catalog_search_indexable_fields",
    "attributes": {
      "fields": [
        {
          "name": "extensions.products(clothing).color",
          "type": "string",
          "facetable": false,
          "sortable": false,
          "locale": "en"
        },
        {
          "name": "shopper_attributes.fabric",
          "type": "string",
          "facetable": false,
          "sortable": false
        },
        {
          "name": "admin_attributes.internal_grade",
          "type": "string",
          "sortable": true
        }
      ],
      "core_field_overrides": [
        {
          "name": "name",
          "stem": true,
          "token_separators": [
            "string"
          ],
          "symbols_to_index": [
            "string"
          ],
          "sortable": true,
          "facetable": true
        }
      ],
      "token_separators": [
        "string"
      ],
      "symbols_to_index": [
        "string"
      ]
    },
    "meta": {
      "owner": "organization"
    }
  }
}

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