Facet Option Configuration

Facet options represent the "values" for Facets. For a Brand facet, these would be Nike, Adidas or Puma.

The facet options API may be used to configure the way facet options are displayed. Using this set of endpoints, you may slot options to specific positions, change their display names, hide them, etc)

Create a facet option config

To add a new facet option configuration to a facet group, use the POST method.

Shell

Create a facet option configuration

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"value": "nature_valley", "display_name": "Nature Valley", "position": 1, "data": null, "hidden": false}'
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~addFacetOptionConfiguration

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
  "value": "nature_valley",
  "display_name": "Nature Valley",
  "position": 1,
  "data": null,
  "hidden": false
}

HTTP request

POST https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.

JSON Parameters

Attribute	Type	Required?	Description
value	string	Yes	A value for this facet option. Must be unique for particular facet
display_name	string	No	A display name for this facet option. Default value is null
position	integer	No	Used to order facet options. Default value is null
hidden	boolean	No	Specifies whether the facet option is hidden from users. Default value is false
data	dict	No	Dictionary with any extra facet option data. Default value is null

Get all option configs for facet

To get configurations of all facet options for a particular facet group, use the GET method.

Shell

Get facet options

curl -X GET \
  -H "Content-Type: application/json" \
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]&page=[page number]&num_results_per_page=[number of facet options per page]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~getFacetOptionConfigurations

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
    "facet_options": [
        {
            "value": "Nature Valley",
            "display_name": "nature_valley",
            "position": 1,
            "data": null,
            "hidden": false,
        },
        {
            "value": "McCormick's Organics",
            "display_name": "mccormicks-organics",
            "position": 2,
            "data": null,
            "hidden": false,
        },
        ...
    ],
    "total_count": 10,
}

HTTP request

GET https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]&page=[page number]&num_results_per_page=[number of facet options per page]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.
page	integer	No	The page number of the results. Defaults to 1. Can't be used together with 'offset'
offset	integer	No	The number of results to skip from the beginning. Can't be used together with 'page'
num_results_per_page	integer	No	The number of results per page to return. Defaults to 100.

Batch update or create facet options configs

To update or create multiple facet options, use the PATCH method. If a facet option config with provided value already exists it is updated partially, otherwise it is created.

Shell

Batch update or create facets options configs

curl -X PATCH \
  -H "Content-Type: application/json" \
  -u "[your token]" \
  -d '[{"value": "nature_valley", "display_name": "New display name"}, {"display_name": "McCormick Organics", "value": "mccormicks-organics", "position": 2, "hidden": false}]'
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~addOrModifyFacetOptionConfigurations

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

[
  {
    "value": "nature_valley",
    "display_name": "New display name",
    "position": 1,
    "data": null,
    "hidden": false
  },
  {
    "value": "mccormicks-organics",
    "display_name": "McCormick Organics",
    "position": 2,
    "data": null,
    "hidden": false
  }
]

HTTP request

PATCH https://ac.cnstrc.com/v1/facets/<facet_group_name>/options?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.

JSON Parameters

Batch update endpoint expects a list of item updates. Each item parameters can be any subset of those listed in the Create a facet option configuration section, except that value parameter is required (to identify which facet options config to update).

Get a single facet option config

To retrieve the configuration of a single facet option, use the GET method.

Shell

Get facet option

curl -X GET \
  -H "Content-Type: application/json" \
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~getFacetOptionConfiguration

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
  "value": "nature_valley",
  "display_name": "Nature Valley",
  "position": 1,
  "data": null,
  "hidden": false
}

HTTP request

GET https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.

Update facet option (total)

To update the configuration of a facet option completely (replace), use the PUT method.

caution

This will overwrite all other configurations you may have defined for the facet option, resetting them to their defaults.

Shell

Replace facet option's configurations

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"value": "nature_valley", "display_name": "Nature Valley", "position": 1, "data": null, "hidden": false}' \
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~replaceFacetOptionConfiguration

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
  "value": "nature_valley",
  "display_name": "Nature Valley",
  "position": 1,
  "data": null,
  "hidden": false
}

HTTP request

PUT https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.

JSON Parameters

The JSON parameters are the same as those in the Create a facet option configuration section.

Update facet option (partial)

To update the configuration of a facet option partially (change only some attributes), use the PATCH method.

Shell

Modify facet option

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Nature Valley"}' \
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~modifyFacetOptionConfiguration

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
  "value": "nature_valley",
  "display_name": "Nature Valley",
  "position": 1,
  "data": null,
  "hidden": false
}

HTTP request

PATCH https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.

JSON Parameters

The JSON parameters can be any subset of those listed in the Create a facet configuration section.

Delete a facet option config

To delete the configuration of a facet option from the facet, use the DELETE method.

Only do this if you want all configuration options for the facet option to go back to their default values.

Shell

Delete a facet option configuration

curl -X DELETE \
  -H "Content-Type: application/json" \
  -u "[your token]"
  "https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]"

JavaScript

// Node
// Please refer to https://Krestor-io.github.io/Krestorio-node/module-catalog.html#~removeFacetOptionConfiguration

Python

# This method is not currently supported.

Java

// This method is not currently supported.

iOS

// This method is not currently supported.

Android

// This method is not currently supported.

C#

// This method is not currently supported.

Response

{
  "value": "nature_valley",
  "display_name": "Nature Valley",
  "position": 1,
  "data": null,
  "hidden": false
}

HTTP request

DELETE https://ac.cnstrc.com/v1/facets/<facet_group_name>/options/<facet_option_value>?key=[your API key]&section=[your section]

URL Parameters

Attribute	Type	Required?	Description
section	string	No	The section in which your facet is defined. Typically, this will be Products.