Streaming Property Service

Introduction

The streaming-property service is leveraged to define property definitions for a specific item type. A group of property definitions for one item type is called a property definition collection. Published property definition collections are required to be associated to a snapshot.

Currently, there are six item types: product, category, region, reference content, assortments, and visibility. Each item type can have different property definitions, which represent the attributes of an item type.

For more information on creating and managing the property definition collections, refer to Property Definition Collections

Types of Property Definitions

In a property definition collection, there are three types of property definitions:

1. Canonical properties: 

   • Pre-defined property definitions

   • Clients can provide data for canonical attributes at ingest time

   • Some canonical properties are required by Algonomy products.

   • It is recommended not to modify canonical properties as Algonomy applications require them.

     However, search attributes (findAttributeSettings) can be altered. For example, "storable" can be changed to true or false, and propertyValueStyle can be modified.

2. Derived properties:  

   • These are reserved system properties populated by Algonomy applications.

   • They must not be used for custom property definitions or during product ingestion.

   Exception for Streaming Find only:

   • "product_effectiveprice_cents" (Long) is an optional attribute that must be provided by the customer.

   • The value should be in cents, not dollars.

   • Batch clients do not need to send this, as it is auto-calculated.

   How to calculate product_effectiveprice_cents:

   Send the lowest of list price and sale price, in cents.

   Calculation rules:

   • If sale price is missing → use list price

   • If sale price < list price → use sale price

   • If sale price ≥ list price → use list price

   Examples:

   • list_price = 10.00, sale_price = 8.50 → send 850

   • list_price = 10.00, sale_price = 10.00 → send 1000

   • list_price = 10.00, sale_price = 12.00 → send 1000 (ignore sale price)

   • list_price = 10.00, sale_price not provided → send 1000

3. Custom properties:

   • Client defined properties.

   • There is a list of "reserved words" that cannot be used for a custom attributes. For more information on reserved words, see Reserved Words.

Modifications to Canonical and Derived Property Definitions

Canonical and derived property definitions are pre-defined and are automatically created when the property definition collection is created. The only modifiable elements in a canonical or derived property definition:

• findAttributeSettings

  • Find search attributes

• propertyValueStyle

• scopedActionSettings

  • For Scoped Actions: The property with this element limits a scoped action to a set based on the value of the property. This is usually used with custom property definitions

Modifying other elements in a canonical property , such as canonicalName, will cause the property definition collection update fail. Derived properties cannot be used when ingesting products, as they are reserved for Algonomy products.

It is recommended not to remove any canonical properties as each Algonomy product requires specific properties.

• Recommend requires the following properties: product_id, name, image_url, link_url, price and recommendable.

  Note: 'Image_url' is a required canonical property that needs to be ingested. For customers without images, this field should be populated with a dummy ID.

• Find: If the image_url is not populated in a product, then those products will not be returned in the result set by default. A workaround is to use the "fl" (field list) parameter and not include the image_url. This way, products without an image_url will still be returned.

  • Find ignores the "recommendable" property.

Examples:

Below is an example of the canonical property definition for rating:

"rating": {
            "canonicalName": "product_rating",
            "dataType": "float",
            "origin": "canonical",
            "propertyValueStyle": "baseOnly",
            "required": false,
            "findAttributeSettings": {
                "facetable": true,
                "storable": true,
                "searchable": true,
                "filterable": true,
                "sortable": false,
                "regionAware": false,
                "customerAware": false,
                "excludeFromSpellcheck": false,
                "exactMatch": false,
                "queryTaggable": false
            }
          }

Custom property definitions must be provided for items that require specific attributes. For example, if a product has an attribute called "promotion", then this attribute needs to be defined in the property definition collection before ingesting the product. Failure to define an attribute in the property definition collection, will result in the ingested product failing.

Property definitions collections are required to create a snapshot, and catalog items can only be ingested once a snapshot is created.

Product Snapshot: Requires both product and category property definition collections

Place Snapshot: Requires the region property definition collection.

Specific Requirements for Find

The search attribute settings (findAttributeSettings) must be set in the product definition collection. These settings are only required in the product definition collection and not in the other property definition collections.

Note: The Streaming Catalog does not utilize the current Portal Search Attributes when setting up the index. By default only the canonical attributes are initially displayed in the Portal Search Attributes. However, attributes that are searchable are still required in the Portal Search Attributes to include them in the search configuration (sliders). Only the "searchable" parameter is required. Other parameters such as "facetable" will be ignored.

If the image_url is not populated, those products will not be returned in the Find result set. For customers who do not have images, there are two options available. The first option is to provide a dummy value for the image_url. The second option is to use the "fl" parameter (field list) and exclude the image_url from the list of fields to be returned by the query. This way, products without an image_url will be returned. For more information, see Find API - fl parameter .

Property Definition Collections

Each property definition collection contains property definitions for a specific item type (product, category, region or referenceContent).

There are five actions for property definition collections: create, publish, clone, archive and delete. There are four states: creating, published, archived, and deleted.

Create a new property definition collection

When a property definition collection is "created", the response includes all the canonical and derived attributes specific to the item type along with the collectionId. The collection state will be "creating". Any property definition can be updated, or new property definitions added while in the "creating" state. Once the property definition collection is "published", existing property definitions cannot be updated but new ones can be added at any time.

The below syntax is used to create a new property definition collection. For more information, see Syntax Overview. An example API call with a full response is available in the Examples section

 POST https://<host>/streaming-property/v1/<apiKey>/collections/<itemType>

Update an existing property definition - "creating" state only

Existing property definitions can only be updated in property definition collections that are in the "creating" state. For any update, a complete property definition is required. To update either the PUT or PATCH methods can be used.

Below is the syntax for PATCH where one or more property definitions can be updated.

PATCH https://<host>/streaming-property/v1/<apiKey>/collections/<itemType>/<collectionId>/definitions

The example below illustrates changing a canonical property's find attributes. In this case the facetable parameter is changed to false.

collectionID: 123, itemType: product.

PATCH https://<host>/streaming-property/v1/<apiKey>/collections/product/123/definitions
Body
{
 "brand": {
                "canonicalName": "product_brand",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 255,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            }
  }

Add a new property definition

A  new property definition can be added to a "creating" or "published" property definition collection with no restrictions.

The most common requirement is to add a custom property. The syntax for adding a new property definition is the same as updating a property definition.

Modify an existing property in a "published" property definition collection

• If changes are required, for an existing property definition, you have two options. You can either create a new property definition collection or clone the existing collection. The new or cloned collection will be in the “creating” state, allowing you to make updates.If the property definition was used by a snapshot, a new snapshot needs to be created to leverage the new property definition collection.

Support of SKU Feature with Streaming

Starting from the May 2023 release, the Personalization platform supports the SKU feature with Streaming. This allows you to ingest SKU data via the Streaming API, which will be consumed by the platform’s SKU functionality. In addition to ingesting SKU data via the Streaming API, you need to add SKU to your instrumentation to support this functionality.

Note: Currently support for SKUs is not compatible with support for regions. This means, it's not possible to set attributes such as price and availability to work differently for each product SKU in a region. For example, you cannot define a region-specific price and availability for a product that is different from the parent product.

Adding SKU as New Attributes to Product Property Definition

To update a Property definition, either the PUT or PATCH methods can be used. Below is the syntax for PUT method, where SKU property definitions are being added to an existing published collection.

PUT https://<host>/streaming-property/v1/<apiKey>/collections/<itemType>/<collectionId>/definitions

The example below illustrates adding color, size, and style as SKU-specific attributes to the existing product properties.

collectionID: 123, itemType: product.

PATCH https://<host>/streaming-property/v1/<apiKey>/collections/product/123/definitions

Body
{
  "color": {
        "dataType": "string",
        "propertyValuestyle:fullyCoveredOverride,
        "origin": "custom",
        "lengthLimit": 1024
        "required": false
    },
        "size": {
        "dataType": "string",
        "propertyValuestyle:fullyCoveredOverride,
        "origin": "custom",
        "lengthLimit": 1024
        "required": false
    },
    "style": {
        "dataType": "string",
        "propertyValuestyle:fullyCoveredOverride,
        "origin": "custom",
        "lengthLimit": 1024
        "required": false
    }
    }

Note: For customers who plan to use SKU with the Search service (Streaming Find), it is necessary to define SKU attributes with the propertyValuestyle:fullyCoveredOverride. this is because SKU is treated as an override feature with Streaming Find (similar to language).

Notes

Property definition collections must to be created before creating a snapshot. Currently "Published" property definition collections are required for all snapshot states: "creating", "complete" or "active". All snapshots must reference the required property definition collections.

There are distinct snapshot types for product, place, and referenceContent.

• Product snapshots require both product and category property definition collections.

• Place snapshots only require the region property definition collection.

• referenceContent snapshot requires the referenceContent property definition collection.

Streaming-Property Syntax for Creating and Managing Property Definition Collections

Hosts:

Production

https://gateway.richrelevance.com/

QA

https://qa-gateway.richrelevance.com/

Staging

https://staging-gateway.richrelevance.com/

The following syntax is for creating, managing state, and getting details of a property definition collection.

Base URL: https://<host>/streaming-property/v1/

Full URL: https://<host>/streaming-property/v1/<apiKey>/collections/<itemType>/<collectionId>/<action>

API Endpoints

Parameters

Property Definitions 

Below are actions and syntax for managing property definitions in a property definition collection.

New property definitions and updates can only be applied to a “creating” collection. When updating or creating, a property definition needs to be complete.

Property Definition Actions and Syntax

Base URL: https://<host>/streaming-property/v1/

'Authorization:Bearer <tokenValue>’

Full URL: https://<host>/streaming-property/v1/<apiKey>/collections/<itemType>/<collectionId>/definitions

'Authorization:Bearer <tokenValue>’

Property Definition Elements

findAttributeSettings (Find Streaming Attribute Settings)

ngramSearch

N-grams are like a sliding window that moves across a word, a continuous sequence of characters of a specified length which in Find is defaulted to 1. ngramSearch is often used with autocomplete or type-ahead feature. For example, a shopper types each character in the search box, there is a match based on the characters entered. Some Find customers use the Find API for auto-complete of products instead of the autocomplete API. It is important for them to be able to set ngramSearch=true as part of the Find query. It is recommended to set it to ngram=false for general product queries.

There can be a system-wide setting for ngramSearch in the site configuration which an Algonomy consultant sets up. If it is not set up in the site configuration, the default is true. This parameter will override the settings in the site configuration as well as the default value.

ngramSearch=true/false

edgeNgramSearchable

edgeNgramSearchable is a property definition setting for streaming clients to restrict ngram token generation on specific fields. It works on the logic of existing ngramSearch.

• Allows partial matching on this field (min:1).

• Matches only on prefix characters.

• “ABC” will match the field with ABC123DEF but “123" will NOT match.

ngramSearchable

• Allows substring matching.

• In any part of a word (min:3 and max:20 characters).

• For example, “123” will match the field with ABC123DEF.

Note: To use ngramsearch property configurations instead of the “sitewide” ngramSearch, this needs to be enabled with the assistance of your Algonomy consultant or support team.

Partial Matching

edgeNgramSearchable is a property definition settings for streaming clients to restrict ngram token generation to specific fields instead of using ngram logic to all searchable fields. It works on top of the logic of the existing ngramSearch configuration and parameter.

For more information about Search API, see Search API.

queryTaggable

Query understanding (queryTaggable) aims to accurately deduce the user's intended meaning behind their query, refine the query to better reflect its purpose, and assist the user in crafting their query with a clear intent. Typically, this process occurs prior to the search engine's retrieval and ranking of search results.

Query tagging addresses point 2 of this diagram: Query segmentation and tagging.

For e-commerce search, the semantic labels can be different properties and their values, such as brand, color, model, style, and so on. An example of query semantic tagging in the product domain is shown in the following where the labels are in parentheses.

cheap (SortOrder) garmin (Brand) c340 (Model) gps (Type)

Implementation of query understanding in Find

• A new item type is introduced "querytag" to store named entity document information in catalog tagger solr collection.

• querytag property definition must be added with product property definition while creating a new snapshot.

  • With these properties, we can leverage the enrichment service to calculate scores based on some data analytics algorithms and add those scores to the base querytags.

• A checkpoint event is triggered to index querytags to catalog tagger collection. This takes catalog facets from catalog collection and index to catalog tagger collection.

• Catalog tagger collection holds the catalog facets so it's a part of product data only.

Enabling Query understanding for a client

1. Portal: Enable Query Understanding checkbox and add query understanding json in complementary json.

2. Property definition: Add queryTaggable in findAttributeSettings for the query understanding fields.

3. Snapshot: Create and complete snapshot and ingest catalog data.

4. Checkpoint: Run checkpoint event.

5. Find API: Run Find API and verify using the queryUnderstanding section in the response.

Portal configuration

1. Select the Query Understanding Enabled checkbox in the portal.



2. Add query understanding json in the complementary json.

#Query side configuration
#Both streaming and batch
#Field wise configuration. one global switch to make query understanding tagging on/off
#Need not to send false flags: false flag feature does not apply.

Complementary search json
{
    "tagging": {
        "queryEnabled": true,
        "querytagField": "querytag_name",
        "querytagPropertyField": "attribute",
        "reformulateQuery": true,
        "querytagSettings": {
            "product": {
                "properties": {
                    "product_brand": {
                        "boost": 10,
                        "filter": true,
                        "psDisable": true
                    },
                    "Gender": {
                        "boost": 10,
                        "filter": true
                    },
                    "product_category_name": {
                        "boost": 10,
                        "filter": true
                    },
                    "Feature_Length": {
                        "boost": 10,
                        "filter": true,
                        "exclude":true
                    },
                    "SizeAvailable": {
                        "boost": 10,
                        "filter": true,
                        "exclude":true
                    }
                }
            }
        }
    }
}

Querytag features

"boost": 20
Query intent boosting
boost will be used in solr query bq
-bq=product_brand^2.0

"filter": true
ENG-25349 : Brand (and other field) "Classfiers" - automatic filtering

"exclude": true
removes querytag value from search query. 
Helps to save zero results in case of field not searchable and mm=100%
PF-776 OffMenu type functionality - with exact match only on one field and optional other terms

"psDisable": true
Remove matched querytag attribute from rrpsbq
ENG-25042, ENG-25348     

3. Create and complete the snapshot and ingest catalog data.

4. Checkpoint Event:

   1. With an already active snapshot e scheduled job will run to update the query tagger data with the updated catalog data.

   2. To populate the query tagger of a complete snapshot or after activating a new snapshot, this checkpoint event needs to be called directly to ensure immediate population of the data.

   3. One should wait approximately 15 minutes upon completion of the full catalog ingest, to allow for the commit to have been executed – or the completion can be checked with the tracking status or catalog count before calling the checkpoint.

5. Example Find API:
   Run the below Find API and verify using the queryUnderstanding section in the response.

   Copy

   https://staging.richrelevance.com/rrserver/api/find/v1/0fd701d838a173d9?lang=en&placement=search_page.find_app&query=jeans+blue&rows=30&log=false&fl=id%2CimageId%2Cname%2ClinkId%2CColorHex&filter=in_stock%3Atrue&facet=product_brand&facet=Gender&facet=product_brand&facet=Feature_Color&snapshot=3933&searchConfig.queryUnderstanding=%7B%22tagging%22%3A%7B%22queryEnabled%22%3Atrue%2C%22querytagField%22%3A%22querytag_name%22%2C%22querytagPropertyField%22%3A%22attribute%22%2C%22reformulateQuery%22%3Atrue%2C%22querytagSettings%22%3A%7B%22product%22%3A%7B%22properties%22%3A%7B%22Feature_Color%22%3A%7B%22filter%22%3Atrue%2C%22exclude%22%3Atrue%7D%2C%22DefaultCategoryName%22%3A%7B%22filter%22%3Atrue%2C%22exclude%22%3Afalse%7D%7D%2C%22futureFlags%22%3A%7B%7D%7D%2C%22referenceContent%22%3A%7B%22properties%22%3A%7B%22name%22%3A%7B%7D%7D%2C%22futureFlags%22%3A%7B%7D%7D%7D%7D%7D&errorDetails=summary

   Response

   Copy

   {"request":{"apiKey":"0fd701d838a173d9","placements":["search_page.find_app"],"sessionId":"null","userId":"null"},"placements":[{"rcs":"eF4FwbENgDAMBMAmFbu85HdwHG_AGhATiYIOmJ-7Ut6xUaN2N0E327FKd3jaQGSrnPs80s_l_p4rhaENdEZXpYqEggHwB4FgEWo","queryUnderstanding":{"queryUnderstandingStage":"QUERYTAG_OPERATION","filters":["DefaultCategoryName:\"Jeans\"","Feature_Color:\"Blue\""],"excludeTerms":{"excludedTerms":["Blue"],"finalQuery":"jeans"}},"addtoCartParams":"page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b","facets":[{"values":[{"filter":"{!tag=product_brand}product_brand:\"Bare\\ Denim\"","count":743,"value":"Bare Denim"},{"filter":"{!tag=product_brand}product_brand:\"People\"","count":535,"value":"People"},{"filter":"{!tag=product_brand}product_brand:\"SF\\ Jeans\"","count":334,"value":"SF Jeans"},{"filter":"{!tag=product_brand}product_brand:\"PE\\ Jeans\"","count":222,"value":"PE Jeans"},{"filter":"{!tag=product_brand}product_brand:\"Pantaloons\\ Junior\"","count":195,"value":"Pantaloons Junior"},{"filter":"{!tag=product_brand}product_brand:\"Kraus\"","count":121,"value":"Kraus"},{"filter":"{!tag=product_brand}product_brand:\"Solly\\ Jeans\"","count":112,"value":"Solly Jeans"},{"filter":"{!tag=product_brand}product_brand:\"Chalk\"","count":81,"value":"Chalk"},{"filter":"{!tag=product_brand}product_brand:\"Spykar\"","count":69,"value":"Spykar"},{"filter":"{!tag=product_brand}product_brand:\"Louis\\ Philippe\\ Jeans\"","count":58,"value":"Louis Philippe Jeans"},{"filter":"{!tag=product_brand}product_brand:\"Bare\\ Kids\"","count":46,"value":"Bare Kids"},{"filter":"{!tag=product_brand}product_brand:\"Allen\\ Solly\"","count":35,"value":"Allen Solly"},{"filter":"{!tag=product_brand}product_brand:\"Byford\"","count":30,"value":"Byford"},{"filter":"{!tag=product_brand}product_brand:\"Vdot\"","count":27,"value":"Vdot"},{"filter":"{!tag=product_brand}product_brand:\"Poppers\"","count":24,"value":"Poppers"},{"filter":"{!tag=product_brand}product_brand:\"Alto\\ Moda\"","count":19,"value":"Alto Moda"},{"filter":"{!tag=product_brand}product_brand:\"Pantaloons\\ Baby\"","count":17,"value":"Pantaloons Baby"},{"filter":"{!tag=product_brand}product_brand:\"Van\\ Heusen\"","count":17,"value":"Van Heusen"},{"filter":"{!tag=product_brand}product_brand:\"Celio\"","count":16,"value":"Celio"},{"filter":"{!tag=product_brand}product_brand:\"VH\\ Sport\"","count":14,"value":"VH Sport"},{"filter":"{!tag=product_brand}product_brand:\"Jealous\"","count":13,"value":"Jealous"},{"filter":"{!tag=product_brand}product_brand:\"PE\\ Casual\"","count":13,"value":"PE Casual"},{"filter":"{!tag=product_brand}product_brand:\"AND\"","count":12,"value":"AND"},{"filter":"{!tag=product_brand}product_brand:\"Urban\\ Eagle\"","count":9,"value":"Urban Eagle"},{"filter":"{!tag=product_brand}product_brand:\"StyleUp\"","count":6,"value":"StyleUp"},{"filter":"{!tag=product_brand}product_brand:\"Peter\\ England\\ Jeans\"","count":5,"value":"Peter England Jeans"},{"filter":"{!tag=product_brand}product_brand:\"Indigo\\ Nation\"","count":3,"value":"Indigo Nation"},{"filter":"{!tag=product_brand}product_brand:\"Street\\ Armor\"","count":2,"value":"Street Armor"},{"filter":"{!tag=product_brand}product_brand:\"US\\ Polo\\ Assn\"","count":2,"value":"US Polo Assn"},{"filter":"{!tag=product_brand}product_brand:\"Aurelia\"","count":1,"value":"Aurelia"},{"filter":"{!tag=product_brand}product_brand:\"Chirpie\\ Pie\"","count":1,"value":"Chirpie Pie"},{"filter":"{!tag=product_brand}product_brand:\"Coolsters\"","count":1,"value":"Coolsters"},{"filter":"{!tag=product_brand}product_brand:\"Peter\\ England\\ Casuals\"","count":1,"value":"Peter England Casuals"},{"filter":"{!tag=product_brand}product_brand:\"UCB\"","count":1,"value":"UCB"}],"facet":"brand"},{"values":[{"filter":"{!tag=Gender}Gender:\"Men\"","count":1472,"value":"Men"},{"filter":"{!tag=Gender}Gender:\"Women\"","count":911,"value":"Women"},{"filter":"{!tag=Gender}Gender:\"Boys\"","count":321,"value":"Boys"},{"filter":"{!tag=Gender}Gender:\"Girls\"","count":63,"value":"Girls"},{"filter":"{!tag=Gender}Gender:\"Baby\"","count":18,"value":"Baby"}],"facet":"Gender"},{"values":[{"filter":"{!tag=Feature_Color}Feature_Color:\"Blue\"","count":2785,"value":"Blue"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Medium\\ blue\"","count":1630,"value":"Medium blue"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Black\"","count":1150,"value":"Black"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Navy\"","count":1082,"value":"Navy"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Light\\ blue\"","count":676,"value":"Light blue"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Grey\"","count":401,"value":"Grey"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Medium\\ grey\"","count":244,"value":"Medium grey"},{"filter":"{!tag=Feature_Color}Feature_Color:\"White\"","count":143,"value":"White"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Charcoal\"","count":104,"value":"Charcoal"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Light\\ grey\"","count":88,"value":"Light grey"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Olive\"","count":71,"value":"Olive"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Brown\"","count":24,"value":"Brown"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Green\"","count":21,"value":"Green"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Khaki\"","count":20,"value":"Khaki"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Beige\"","count":19,"value":"Beige"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Pink\"","count":18,"value":"Pink"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Maroon\"","count":12,"value":"Maroon"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Cream\"","count":9,"value":"Cream"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Off\\ white\"","count":9,"value":"Off white"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Red\"","count":7,"value":"Red"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Dark\\ green\"","count":5,"value":"Dark green"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Tan\"","count":5,"value":"Tan"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Light\\ green\"","count":4,"value":"Light green"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Light\\ olive\"","count":4,"value":"Light olive"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Purple\"","count":4,"value":"Purple"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Lilac\"","count":2,"value":"Lilac"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Orange\"","count":2,"value":"Orange"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Peach\"","count":2,"value":"Peach"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Rust\"","count":2,"value":"Rust"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Black\\-pink\\-navy\"","count":1,"value":"Black-pink-navy"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Dark\\ grey\"","count":1,"value":"Dark grey"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Dark\\ khaki\"","count":1,"value":"Dark khaki"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Dark\\ olive\"","count":1,"value":"Dark olive"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Indigo\"","count":1,"value":"Indigo"},{"filter":"{!tag=Feature_Color}Feature_Color:\"Wine\"","count":1,"value":"Wine"}],"facet":"Feature_Color"}],"searchTrackingUrl":"","docs":[{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=526833&ind=0&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2F-blue-solid-jeans-526833.html","score":6,"linkId":"https://test.pantaloons.com/p/-blue-solid-jeans-526833.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/526833-3986641.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"526833"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=405356&ind=1&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-medium-blue-skinny-fit-full-length-jeans-405356.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-medium-blue-skinny-fit-full-length-jeans-405356.html","imageId":"https://pantaloons.imgix.net/img/app/product/4/405356-2268692.jpg?auto=format","name":"Blue Textured Ankle-Length Casual Men Skinny Fit Jeans","id":"405356"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=199138&ind=2&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-denim-jeans-199138.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-denim-jeans-199138.html","imageId":"https://pantaloons.imgix.net/img/app/product/1/199138-596099.jpg?auto=format","name":"Blue Solid Full length Casual Women Ultra Slim Fit Jeans","id":"199138"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=393057&ind=3&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-ice-blue-skinny-fit-full-length-jeans-393057.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-ice-blue-skinny-fit-full-length-jeans-393057.html","imageId":"https://pantaloons.imgix.net/img/app/product/3/393057-2073553.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Skinny Fit Jeans","id":"393057"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=599639&ind=4&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fblue-solid-jeans-599639.html","score":6,"linkId":"https://test.pantaloons.com/p/blue-solid-jeans-599639.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/599639-5592667.jpg?auto=format","name":"Blue Solid Full length Casual Women Regular Fit Jeans","id":"599639"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=264132&ind=5&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-indigo-blue-skinny-fit-full-length-jeans-264132.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-indigo-blue-skinny-fit-full-length-jeans-264132.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/264132-1040256.jpg?auto=format","name":"Blue Solid Low Rise Casual Men Skinny Fit Jeans","id":"264132"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=257718&ind=6&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-indigo-blue-skinny-fit-full-length-jeans-257718.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-indigo-blue-skinny-fit-full-length-jeans-257718.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/257718-986012.jpg?auto=format","name":"Blue Solid Full length Casual Men Ultra Slim Fit Jeans","id":"257718"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=356062&ind=7&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-light-blue-skinny-fit-full-length-jeans-356062.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-light-blue-skinny-fit-full-length-jeans-356062.html","imageId":"https://pantaloons.imgix.net/img/app/product/3/356062-1777620.jpg?auto=format","name":"Blue Solid Low Rise Casual Men Skinny Fit Jeans","id":"356062"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=289339&ind=8&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-mid-rise-skinny-push-up-blue-denim-289339.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-mid-rise-skinny-push-up-blue-denim-289339.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/289339-1235057.jpg?auto=format","name":"Blue Solid Casual Women Ultra Slim Fit Jeans","id":"289339"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=530484&ind=9&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fpeter-england-jeans-blue-textured-jeans-530484.html","score":6,"linkId":"https://test.pantaloons.com/p/peter-england-jeans-blue-textured-jeans-530484.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/530484-4028896.jpg?auto=format","name":"Blue Textured Ankle-Length Casual Men Ultra Slim Fit Jeans","id":"530484"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=529078&ind=10&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Flouis-philippe-jeans-blue-solid-jeans-529078.html","score":6,"linkId":"https://test.pantaloons.com/p/louis-philippe-jeans-blue-solid-jeans-529078.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/529078-4011167.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"529078"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=201309&ind=11&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-denim-jeans-201309.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-denim-jeans-201309.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/201309-607767.jpg?auto=format","name":"Blue Solid Full length Casual Women Ultra Slim Fit Jeans","id":"201309"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=199146&ind=12&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-denim-jeans-199146.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-denim-jeans-199146.html","imageId":"https://pantaloons.imgix.net/img/app/product/1/199146-596150.jpg?auto=format","name":"Blue Solid Full length Casual Women Ultra Slim Fit Jeans","id":"199146"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=526845&ind=13&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2F-blue-solid-jeans-526845.html","score":6,"linkId":"https://test.pantaloons.com/p/-blue-solid-jeans-526845.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/526845-3986707.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"526845"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=231295&ind=14&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-231295.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-231295.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/231295-804818.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Women Ultra Slim Fit Jeans","id":"231295"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=530371&ind=15&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fpeter-england-jeans-blue-textured-jeans-530371.html","score":6,"linkId":"https://test.pantaloons.com/p/peter-england-jeans-blue-textured-jeans-530371.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/530371-4028164.jpg?auto=format","name":"Blue Textured Ankle-Length Casual Men Skinny Fit Jeans","id":"530371"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=226102&ind=16&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-indigo-blue-skinny-fit-full-length-jeans-226102.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-indigo-blue-skinny-fit-full-length-jeans-226102.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/226102-769236.jpg?auto=format","name":"Blue Solid Full length Casual Men Ultra Slim Fit Jeans","id":"226102"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=530332&ind=17&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fpeter-england-jeans-blue-textured-jeans-530332.html","score":6,"linkId":"https://test.pantaloons.com/p/peter-england-jeans-blue-textured-jeans-530332.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/530332-4027936.jpg?auto=format","name":"Blue Textured Ankle-Length Casual Men Slim Fit Jeans","id":"530332"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=264927&ind=18&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-264927.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-264927.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/264927-1045297.jpg?auto=format","name":"Blue Solid Casual Men Ultra Slim Fit Jeans","id":"264927"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=755942&ind=19&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fblue-jeans-755942.html","score":6,"linkId":"https://test.pantaloons.com/p/blue-jeans-755942.html","imageId":"https://pantaloons.imgix.net/img/app/product/7/755942-11031492.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"755942"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=526693&ind=20&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2F-grey-solid-jeans-526693.html","score":6,"linkId":"https://test.pantaloons.com/p/-grey-solid-jeans-526693.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/526693-3988663.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"526693"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=647224&ind=21&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fdark-blue-washed-jeans-647224.html","score":6,"linkId":"https://test.pantaloons.com/p/dark-blue-washed-jeans-647224.html","imageId":"https://pantaloons.imgix.net/img/app/product/6/647224-11019133.jpg?auto=format","name":"Blue Solid Full Length Casual Men Slim Fit Jeans","id":"647224"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=285961&ind=22&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-285961.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-285961.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/285961-1208914.jpg?auto=format","name":"Blue Solid Casual Men Slim Fit Jeans","id":"285961"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=529375&ind=23&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fpantaloons-blue-jeans-529375.html","score":6,"linkId":"https://test.pantaloons.com/p/pantaloons-blue-jeans-529375.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/529375-4013322.jpg?auto=format","name":"Pantaloons Blue Jeans","id":"529375"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=265828&ind=24&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-265828.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-265828.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/265828-1050500.jpg?auto=format","name":"Blue Solid Casual Men Slim Fit Jeans","id":"265828"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=266909&ind=25&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-266909.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-266909.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/266909-1057465.jpg?auto=format","name":"Blue Solid Casual Men Comfort Fit Jeans","id":"266909"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=235977&ind=26&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fsf-jeans-blue-jeans-235977.html","score":6,"linkId":"https://test.pantaloons.com/p/sf-jeans-blue-jeans-235977.html","imageId":"https://pantaloons.imgix.net/img/app/product/2/235977-838145.jpg?auto=format","name":"Blue Embroidered Casual Women Ultra Slim Fit Jeans","id":"235977"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=677480&ind=27&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fdark-indigo-jeans-677480.html","score":6,"linkId":"https://test.pantaloons.com/p/dark-indigo-jeans-677480.html","imageId":"https://pantaloons.imgix.net/img/app/product/6/677480-11020421.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Women Skinny Fit Jeans","id":"677480"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=754785&ind=28&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Fblue-jeans-754785.html","score":6,"linkId":"https://test.pantaloons.com/p/blue-jeans-754785.html","imageId":"https://pantaloons.imgix.net/img/app/product/7/754785-11031174.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Skinny Fit Jeans","id":"754785"},{"clickUrl":"http://staging.richrelevance.com/rrserver/api/find/v1/track/click/0fd701d838a173d9?a=0fd701d838a173d9&vg=c82c2ee0-c2ae-4fb1-a941-3e641b388122&pti=2&pa=find_app&hpi=0&stn=PersonalizedProductSearchAndBrowse&stid=184&rti=2&sgs=&mvtId=-1&mvtTs=1719822120092&uguid=12938750-855a-4087-7d5c-9d631fafbd7e&channelId=WEB&s=&pg=-1&page=1&query=jeans+blue&lang=en&searchConfigId=63346234cffae5000cf3c11b&searchType=CATALOG&p=529363&ind=29&ct=https%3A%2F%2Ftest.pantaloons.com%2Fp%2Flouis-philippe-jeans-blue-solid-jeans-529363.html","score":6,"linkId":"https://test.pantaloons.com/p/louis-philippe-jeans-blue-solid-jeans-529363.html","imageId":"https://pantaloons.imgix.net/img/app/product/5/529363-4013237.jpg?auto=format","name":"Blue Solid Ankle-Length Casual Men Slim Fit Jeans","id":"529363"}],"entities":[],"numFound":2785,"merchandisingRuleIds":[],"links":{"directlink":[],"banner":[],"sponsored":[]},"placement":"search_page.find_app","metrics":{"rrPsdScoreBand":"highBand","rrPersonalizationInfluence":"0.0","rrPsdScore":"1.0"},"errors":["STORABLE is not supported by the field ColorHex"]}],"message":"Session ID should be set to use personalization","status":"ok"}

   

Date Formats

• date

  • The format for "date" is based on the short date format defined in the Portal in Admin > Site Configurations

  • In the example below, the format for November 2, 2020 would be 02/11/2020.

  

• datetime

  • The format for "datetime" is based on the long date format defined in the Portal in Admin > Site Configurations.

• Date Filtering and Searching

  Note: Filtering and sorting on dates is an opt-in feature. You must create a new snapshot after enabling the site configuration. To enable this feature, please contact Algonomy Customer Support. For more information, see Date Filtering and Searching.

propertyValueStyle

• baseOnly (default)

  • Property values with this style only appear in the base properties section, and can be directly shown to the customer. Examples include physical properties, such as screen size.

• fullyCoveredOverride

  • Property values with this style appears only in an override section, where each override context has this value. Since there is only one value for a given override context, the value can be directly shown within its context. Examples include language text, where each language code has a translated value. Base values of this property are ignored.

  Note: Currently the Catalog in the Portal requires a base value for an attribute. It is recommended to add a base value (such as the “english” value). Find will still use the override values and not the base value.

• overrideWithDefault

  • Properties with this value style include overrides for some override contexts, but not all, and also have a default value in the base properties section. With this style, all property values must be considered before showing any value to the shopper. Examples include properties that vary by region, such as availability. Due to data optimization, unchanged property values propagate only when the force flag is true. Therefore, either all values need to be updated in all contexts plus the base with force = true, or the consuming application must retrieve the full item from the long-term item store before applying any update when force = false.

Search Attribute Validation Rules

The following are the search attribute validation rules:

• Sortable:

  • Multi-value attributes are not sortable. This applies to any property definition with a dataType that has the "list" suffix, such as "stringList"

  • Only single value attributes may be sortable

• Product_external_id and content_external_id: These must be filterable and storable.

• product_region_id: This is a derived property used internally where "storable" will always be "false". Even if it is changed to "true", Find will not return it in a result set.

• Image attributes: These must be storable.

• Any facetable attribute must be filterable.  

Example 1: Find Search Attributes

Example of adding property definitions with the findAttributeSettings:

• This example adds or updates named definitions to collection 123 of item type "product"

collectionId: 123

apiKey: 1234

PATCH https://<host>/streaming-property/v1/1234/collections/product/123/definitions
“myProperty1”: {
  “dataType”: “string”,
  “origin”: “custom”,
  “propertyValueStyle”: “baseOnly”,
  “required”: false,
  “findAttributeSettings”: {
       “facetable”: false,
       “storable”: false,
       “searchable”: true,
       “filterable”: false,
       “sortable”: false,
       “regionAware”: false,
       "customerAware": false,
       "excludeFromSpellcheck": false,
       "exactMatch": false,
       "queryTaggable": false
           }
  },
“myProperty2”: {
 “dataType”: “string”,
 “origin”: “custom”,
 “propertyValueStyle”: “baseOnly”,
 “required”: false,
 “findAttributeSettings”: {
      “facetable”: false,
       “storable”: false,
       “searchable”: true,
       “filterable”: false,
       “sortable”: false,
       “regionAware”: false,
       "customerAware": false,
       "excludeFromSpellcheck": false,
       "exactMatch": false,
       "queryTaggable": false
       }
 }

Example 2:  Custom property definition "size"

Example of a custom property definition called "size".

Note: The canonicalName is not required. Origin needs to be “custom”.

size":{
"dataType":"string","
"origin":"custom",
  "required":false“,
"findAttributeSettings”: {
    “facetable”: true,
    “storable”: true
    “searchable”: true,
    “filterable”: true,
    “sortable”: true,
    “regionAware”: false,
    "customerAware": false,
    "excludeFromSpellcheck": false,
    "exactMatch": false,
    "queryTaggable": false
       }
}

Steps to create a Property Definition Collection

The following is a step-by-step summary with examples for creating property definition collections for a product snapshot. It is important to consider the states when associating them with snapshots.

Product snapshot requires both published product and category property definition collections.

Place snapshot requires a published region property definition collection.

Summary of steps

1. Create a new product definition collection (POST) - state: "creating"

   • A new product definition with a state of "creating" is created.

   • The response will include all pre-defined canonical and derived properties.

   • The response will also include the collectionId.

   • Example of "POST" call and response is below.

2. Modify and add custom product property definitions for the "creating" product property definition collection (PUT/PATCH).

   • For pre-defined canonical property definitions can only modify:

     • search attributes (under the findAttributeSettings)

     • propertyValueStyle

     • scopedAction

   • Add and modify any custom property definitions.

3. Review changes (GET)

4. Repeat steps 2 and 3 until satisfied with the product property definition collection.

5. Create a category property definition collection following the same steps above (steps 2 and 3).

6. "Publish" both the product and category property definition collections - state: "published".

7. The published property definition collections are ready to be associated to a snapshot.

Examples

The following are examples of creating and managing a product property definition collection.

Creating the Property Definition Collection for a Product Snapshot

Below is the API call to create a product property definition collection.

 POST  https://gateway.richrelevance.com/streaming-property/v1/<apiKey>/collections/product
 'Authorization:Bearer <tokenValue>’

Response: Property definition collection id is returned with state, and all the pre-defined canonical and derived property definitions.

The tracking ID can be found at the end of the response under "statusTracker"

{
    "propertyDefinitionCollection": {
        "id": 11374,
        "name": "11374",
        "itemType": "product",
        "state": "creating",
        "definitions": {
            "end_date": {
                "canonicalName": "product_end_date",
                "dataType": "date",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "storable": false,
                    "searchable": false,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "facetable": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                
                }
            },
            "list_price_max": {
                "canonicalName": "product_price_range_max_cents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "product_region_id": {
                "dataType": "longList",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": false,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "rating": {
                "canonicalName": "product_rating",
                "dataType": "float",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": true,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "description": {
                "canonicalName": "product_description",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": false,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "in_stock": {
                "canonicalName": "in_stock",
                "dataType": "boolean",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": false,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": true,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                                    }
            },
            "product_category_id": {
                "dataType": "longList",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": false,
                    "searchable": false,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
            },
            "product_effectiveprice_cents": {
                "dataType": "price",
                "origin": "derived",
                "propertyValueStyle": "overrideWithDefault",
                "required": false,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": false,
                    "filterable": true,
                    "sortable": true,
                    "regionAware": true,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "product_category_name": {
                "dataType": "stringList",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "price": {
                "canonicalName": "product_pricecents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": false,
                    "filterable": true,
                    "sortable": true,
                    "regionAware": true,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "product_id": {
                "dataType": "long",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "product_sku_id": {
                "dataType": "string",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": false,
                    "searchable": false,
                    "filterable": false,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false

                }
            },
            "link_url": {
                "canonicalName": "product_link_id",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 255,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": false,
                    "filterable": false,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "findable": {
                "canonicalName": "product_findable",
                "dataType": "boolean",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "price_description": {
                "canonicalName": "price_description",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024
            },
            "brand": {
                "canonicalName": "product_brand",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 255,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                                    }
            },
            "start_date": {
                "canonicalName": "product_release_date",
                "dataType": "date",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": false,
                    "searchable": false,
                    "filterable": true,
                    "sortable": true,
                    "customerAware": false,
                    "regionAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "sale_price_min": {
                "canonicalName": "product_sale_price_range_min_cents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "recommendable": {
                "canonicalName": "product_recommendable",
                "dataType": "boolean",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "margin": {
                "canonicalName": "margin",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 50
            },
            "image_url": {
                "canonicalName": "product_image_id",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 255,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": false,
                    "filterable": false,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "sale_price": {
                "canonicalName": "product_saleprice_cents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": false,
                    "filterable": true,
                    "sortable": true,
                    "regionAware": true,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                                    }
            },
            "sale_price_max": {
                "canonicalName": "product_sale_price_range_max_cents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "list_price_min": {
                "canonicalName": "product_price_range_min_cents",
                "dataType": "price",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false
            },
            "name": {
                "canonicalName": "product_name",
                "dataType": "string",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 255,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": false,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "num_reviews": {
                "canonicalName": "product_num_reviews",
                "dataType": "int",
                "origin": "canonical",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "product_category_external_id": {
                "dataType": "stringList",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024,
                "findAttributeSettings": {
                    "facetable": true,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            },
            "product_external_id": {
                "dataType": "string",
                "origin": "derived",
                "propertyValueStyle": "baseOnly",
                "required": false,
                "lengthLimit": 1024,
                "findAttributeSettings": {
                    "facetable": false,
                    "storable": true,
                    "searchable": true,
                    "filterable": true,
                    "sortable": false,
                    "regionAware": false,
                    "customerAware": false,
                    "excludeFromSpellcheck": false,
                    "exactMatch": false,
                    "queryTaggable": false
                }
            }
        }
    },
    "statusTracker": {
        "trackingId": "7f39730a-5fd7-11ea-9cb2-fdac9789e86e",
        "trackingInstant": "2020-03-06T18:22:54.530023400Z"
    }
} 

Adding Custom Property Definitions or Updating existing Property Definitions in a Product Property Definition Collection

You can add new custom property definitions to both "creating" or "published" property definition.

However, modifying an existing property definition, is only allowed in a "creating" collection and not in a "published" property definition.

In the example below, we will add a new property to a published property definition.

collectionID: 26660

PUT http://gateway.richrelevance.com/streaming-property/v1/<apiKey>/collections/product/11374/definitions/size: 
'Authorization:Bearer <tokenValue>’
Body:
{"dataType":"string","origin":"custom","required":false, 
"findAttributeSettings": {"facetable": true,"storable": true, "searchable": true,"filterable": true, "sortable": false,"regionAware": false,"customerAware": false, "excludeFromSpellcheck": false,"exactMatch": false, "queryTaggable": false}}

Response: A trackingID is returned along with the all the properties in the collection include the new property. At the end of the response there is a summary of new, updated, and deleted properties for this specific collection. The snapshot is also referenced as a property definition collection can belong to multiple snapshots.

{
    "statusTracker": {
        "trackingInstant": "2020-11-05T00:39:18.285025200Z",
        "trackingId": "56923ccc-1eff-11eb-88ad-1b7e642befe5"
    },
    "data": {
        "siteId": 608,
        "collection": {
            "id": 26660,
            "name": "26660",
            "itemType": "product",
            "state": "published",
            "definitions": {
                "end_date": {
                    "canonicalName": "product_end_date",
                    "dataType": "date",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": false,
                        "searchable": false,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "list_price_max": {
                    "canonicalName": "product_price_range_max_cents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "product_region_id": {
                    "dataType": "longList",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": false,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "rating": {
                    "canonicalName": "product_rating",
                    "dataType": "float",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": true,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "description": {
                    "canonicalName": "product_description",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": false,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "in_stock": {
                    "canonicalName": "in_stock",
                    "dataType": "boolean",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": false,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": true,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_category_id": {
                    "dataType": "longList",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": false,
                        "searchable": false,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_effectiveprice_cents": {
                    "dataType": "price",
                    "origin": "derived",
                    "propertyValueStyle": "overrideWithDefault",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": false,
                        "filterable": true,
                        "sortable": true,
                        "regionAware": true,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_category_name": {
                    "dataType": "stringList",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "price": {
                    "canonicalName": "product_pricecents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": false,
                        "filterable": true,
                        "sortable": true,
                        "regionAware": true,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_id": {
                    "dataType": "long",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_sku_id": {
                    "dataType": "string",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": false,
                        "searchable": false,
                        "filterable": false,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "link_url": {
                    "canonicalName": "product_link_id",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 255,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": false,
                        "filterable": false,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "findable": {
                    "canonicalName": "product_findable",
                    "dataType": "boolean",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "price_description": {
                    "canonicalName": "price_description",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024
                },
                "brand": {
                    "canonicalName": "product_brand",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 255,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "start_date": {
                    "canonicalName": "product_release_date",
                    "dataType": "date",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": false,
                        "searchable": false,
                        "filterable": true,
                        "sortable": true,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "sale_price_min": {
                    "canonicalName": "product_sale_price_range_min_cents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "recommendable": {
                    "canonicalName": "product_recommendable",
                    "dataType": "boolean",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "margin": {
                    "canonicalName": "margin",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 50
                },
                "image_url": {
                    "canonicalName": "product_image_id",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 255,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": false,
                        "filterable": false,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "store": {
                    "dataType": "string",
                    "origin": "custom",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "scopedActionSettings": {
                        "propertyMatch": true
                    }
                },
                "sale_price": {
                    "canonicalName": "product_saleprice_cents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": false,
                        "filterable": true,
                        "sortable": true,
                        "regionAware": true,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "marce": {
                    "dataType": "string",
                    "origin": "custom",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    },
                    "scopedActionSettings": {
                        "propertyMatch": true
                    }
                },
                "sale_price_max": {
                    "canonicalName": "product_sale_price_range_max_cents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "list_price_min": {
                    "canonicalName": "product_price_range_min_cents",
                    "dataType": "price",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false
                },
                "name": {
                    "canonicalName": "product_name",
                    "dataType": "string",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 255,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": false,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "num_reviews": {
                    "canonicalName": "product_num_reviews",
                    "dataType": "int",
                    "origin": "canonical",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "size": {
                    "dataType": "string",
                    "origin": "custom",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_category_external_id": {
                    "dataType": "stringList",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": true,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                },
                "product_external_id": {
                    "dataType": "string",
                    "origin": "derived",
                    "propertyValueStyle": "baseOnly",
                    "required": false,
                    "lengthLimit": 1024,
                    "findAttributeSettings": {
                        "facetable": false,
                        "storable": true,
                        "searchable": true,
                        "filterable": true,
                        "sortable": false,
                        "regionAware": false,
                        "customerAware": false,
                        "excludeFromSpellcheck": false,
                        "exactMatch": false,
                        "queryTaggable": false
                    }
                }
            }
        },
        "snapshots": {
            "9758": "product"
        },
        "added": [
            "size"
        ],
        "updated": [],
        "removed": []
    }
}

Use the trackingID to check the status as below.

https://<host>/streaming-status/v1/<apiKey>/trackingId/cfe4b2ca-1efe-11eb-88ad-175aaa904061
'Authorization:Bearer <tokenValue>’

Response from status service:

[
    {
        "siteId": 608,
        "snapshotId": 9758,
        "statusId": "d0011401-1efe-11eb-9930-391743bf3b81",
        "trackingId": "cfe4b2ca-1efe-11eb-88ad-175aaa904061",
        "source": "streaming-engine",
        "statusType": "PropertyChangeEvent",
        "message": "PropertyChangeEvent",
        "kafkaSource": {
            "topic": "streaming.engine.in",
            "partition": 7,
            "offset": 331406
        },
        "level": "SUMMARY",
        "statusData": {},
        "datacenter": "qa",
        "trackingInstant": "2020-11-05T00:35:32.333025Z",
        "statusInstant": "2020-11-05T00:35:32.519014500Z",
        "msSinceRequest": 186
    },
    {
        "siteId": 608,
        "snapshotId": 9758,
        "statusId": "cff5c9cb-1efe-11eb-88ad-bfc931fca502",
        "trackingId": "cfe4b2ca-1efe-11eb-88ad-175aaa904061",
        "source": "streaming-property",
        "statusType": "PropertyChangeEvent",
        "message": "PropertyChangeEvent for site: 608, snapshot: (PRODUCT:9758), collection: (PRODUCT:26660)\n added: [size]\n updated: []\n removed: []",
        "level": "SUMMARY",
        "statusData": {},
        "datacenter": "qa",
        "trackingInstant": "2020-11-05T00:35:32.333025Z",
        "statusInstant": "2020-11-05T00:35:32.445025100Z",
        "msSinceRequest": 112
    }
]