Skip to main content

Filter

Supported Type


Create

Description

Filters help your customers to narrow down their search for products on your website, for e.g. size filter, gender filter, and many more. Get notified when a filter is enabled.

Payload

{
"payload":{
"filter":{
"key":"sole-material",
"is_default":false,
"allow_single":false,
"name":"Sole Material",
"logo":"https://hdn-1.fynd.com/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png",
"app_id":"634e82ee1bb7843346def7c2",
"value_config":{
"bucket_points":[

],
"map":{

},
"sort":"count",
"condition":"OR",
"value":""
},
"type":"multivalued",
"priority":13,
"is_active":true,
"id":"63a0ca728bd2f1f421c32b94",
"attribute_name":"Sole Material"
}
},
"meta":{
"event":{
"type":"create",
"name":"filter",
"version":"1"
},
"service":{
"name":"silverbolt"
},
"company_id":577,
"trace_id":[
"silverbolt.4f203ee8-7fdc-11ed-9509-1a7e054c3daa"
],
"created_timestamp":1671481971539,
"application_id":[
"634e82ee1bb7843346def7c2"
]
}
}

Object Properties

NameTypeDescription
keyStringSlug of the product attribute
is_defaultBooleanDefault filter values from the system
allow_singleBooleanYou can disable this to hide filters for a single listed product
nameStringDisplay Name of the filter
attribute_nameStringName of the product attribute
logoStringLogo to show for the filter in the configuration
app_idStringUnique ID of the application
value_configObjectContains the value mapping for the custom filter
bucket_pointsList-ObjectIncase of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}]
startInteger
endInteger
mapObjectMaps the filter value to a display format based on buckets
sortStringSort the filter values based on the selected criteria.
conditionStringCriteria to apply when multivalues are selected in a filter ["AND", "OR"]
valueString
typeStringType of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket
priorityIntegerPosition of the filters.
is_activeBooleanActive status of the filter. Turn off the filter from here.
idStringUUID of the filter config

Update

Description

Filters help your customers to narrow down their search for products on your website, for e.g. size filter, gender filter, and many more. Get notified when an existing filter configuration is modified.

Payload

{
"payload":{
"filter":{
"value_config":{
"sort":"ascending",
"bucket_points":[

],
"map":{
"Test":"test"
},
"value":"",
"condition":"OR"
},
"app_id":"634e82ee1bb7843346def7c2",
"allow_single":false,
"is_default":false,
"name":"Sole Material Update",
"is_active":true,
"priority":13,
"key":"sole-material",
"type":"multivalued",
"logo":"https://hdn-1.fynd.com/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png",
"id":"63a0ca728bd2f1f421c32b94"
}
},
"meta":{
"event":{
"type":"update",
"name":"filter",
"version":"1"
},
"service":{
"name":"silverbolt"
},
"company_id":577,
"trace_id":[
"silverbolt.8cc58352-7fdc-11ed-9b40-22598b72a3df"
],
"created_timestamp":1671482074964,
"application_id":[
"634e82ee1bb7843346def7c2"
]
}
}

Object Properties

NameTypeDescription
keyStringSlug of the product attribute
is_defaultBooleanDefault filter values from the system
allow_singleBooleanYou can disable this to hide filters for a single listed product
nameStringDisplay Name of the filter
attribute_nameStringName of the product attribute
logoStringLogo to show for the filter in the configuration
app_idStringUnique ID of the application
value_configObjectContains the value mapping for the custom filter
bucket_pointsList-ObjectIncase of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}]
startInteger
endInteger
mapObjectMaps the filter value to a display format based on buckets
sortStringSort the filter values based on the selected criteria.
conditionStringCriteria to apply when multivalues are selected in a filter ["AND", "OR"]
valueString
typeStringType of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket
priorityIntegerPosition of the filters.
is_activeBooleanActive status of the filter. Turn off the filter from here.
idStringUUID of the filter config

Delete

Description

Filters help your customers to narrow down their search for products on your website, for e.g. size filter, gender filter, and many more. Get notified when an existing filter configuration is deleted.

Payload

{
"payload":{
"filter":{
"key":"sole-material",
"is_default":false,
"allow_single":false,
"name":"Sole Material Update",
"logo":"https://hdn-1.fynd.com/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png",
"app_id":"634e82ee1bb7843346def7c2",
"value_config":{
"condition":"OR",
"map":{
"Test":"test"
},
"sort":"ascending",
"bucket_points":[

],
"value":""
},
"type":"multivalued",
"priority":13,
"is_active":true,
"id":"63a0ca728bd2f1f421c32b94"
}
},
"meta":{
"event":{
"type":"delete",
"name":"filter",
"version":"1"
},
"service":{
"name":"silverbolt"
},
"company_id":577,
"trace_id":[
"silverbolt.d7db1b68-7fdc-11ed-9b40-22598b72a3df"
],
"created_timestamp":1671482200934,
"application_id":[
"634e82ee1bb7843346def7c2"
]
}
}

Object Properties

NameTypeDescription
keyStringSlug of the product attribute
is_defaultBooleanDefault filter values from the system
allow_singleBooleanYou can disable this to hide filters for a single listed product
nameStringDisplay Name of the filter
attribute_nameStringName of the product attribute
logoStringLogo to show for the filter in the configuration
app_idStringUnique ID of the application
value_configObjectContains the value mapping for the custom filter
bucket_pointsList-ObjectIncase of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}]
startInteger
endInteger
mapObjectMaps the filter value to a display format based on buckets
sortStringSort the filter values based on the selected criteria.
conditionStringCriteria to apply when multivalues are selected in a filter ["AND", "OR"]
valueString
typeStringType of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket
priorityIntegerPosition of the filters.
is_activeBooleanActive status of the filter. Turn off the filter from here.
idStringUUID of the filter config