Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/sort/create/v1
# this event is triggered when sort is created
application/sort/update/v1
# this event is triggered when sort is updated
application/sort/delete/v1
# this event is triggered when sort is deleted
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
weights
object
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
cohorts
object
Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.
Properties
high_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
hyperactive_premium_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
dormant_premium_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
premium_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
potential_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
new_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
average_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "sort"78 ],79 "properties": {80 "sort": {81 "type": "object",82 "required": [83 "app_id",84 "id",85 "key",86 "is_active",87 "priority",88 "is_default",89 "default_key",90 "name"91 ],92 "properties": {93 "id": {94 "type": "string",95 "description": "UUID of the sort config."96 },97 "key": {98 "type": "string",99 "description": "Slug of the sort attribute."100 },101 "logo": {102 "type": "string",103 "description": "Logo to show for the sort in the configuration."104 },105 "name": {106 "type": "string",107 "description": "Display Name of the Sort config."108 },109 "app_id": {110 "type": "string",111 "description": "Unique ID of the application."112 },113 "priority": {114 "type": "integer",115 "description": "Position of the Sort config."116 },117 "is_active": {118 "type": "boolean",119 "description": "Active status of the sort config."120 },121 "is_default": {122 "type": "boolean",123 "description": "Default sorting values from the system."124 },125 "default_key": {126 "type": "string",127 "description": "The default sort key"128 },129 "display_name": {130 "type": "string",131 "description": "Name to be displayed on the storefront in the sorting options."132 },133 "weights": {134 "type": "object",135 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",136 "properties": {137 "popularity": {138 "type": "number",139 "description": "Measures how widely a product is interacted with across users."140 },141 "availability": {142 "type": "number",143 "description": "Represents how readily a product can be fulfilled."144 },145 "conversion": {146 "type": "number",147 "description": "Indicates how effectively a product converts views into purchases."148 },149 "sold_quantity": {150 "type": "number",151 "description": "Reflects historical sales volume of a product."152 },153 "depth": {154 "type": "number",155 "description": "Measures size or variant depth of a product."156 },157 "listing": {158 "type": "number",159 "description": "Represents recency or freshness of the product listing."160 },161 "discount": {162 "type": "number",163 "description": "Indicates the promotional value of a product."164 },165 "cancelled": {166 "type": "number",167 "description": "Reflects historical cancellation reliability of a product or seller."168 },169 "returns": {170 "type": "number",171 "description": "Measures post-purchase return behavior."172 },173 "catalogue": {174 "type": "number",175 "description": "Represents quality and completeness of catalog content."176 },177 "revenue": {178 "type": "number",179 "description": "Represents revenue contribution potential of a product."180 }181 }182 },183 "cohorts": {184 "type": "object",185 "description": "Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.",186 "properties": {187 "high_spender_repeat_customer": {188 "type": "object",189 "description": "Cohort-specific sorting configuration.",190 "properties": {191 "weights": {192 "type": "object",193 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",194 "properties": {195 "popularity": {196 "type": "number",197 "description": "Measures how widely a product is interacted with across users."198 },199 "availability": {200 "type": "number",201 "description": "Represents how readily a product can be fulfilled."202 },203 "conversion": {204 "type": "number",205 "description": "Indicates how effectively a product converts views into purchases."206 },207 "sold_quantity": {208 "type": "number",209 "description": "Reflects historical sales volume of a product."210 },211 "depth": {212 "type": "number",213 "description": "Measures size or variant depth of a product."214 },215 "listing": {216 "type": "number",217 "description": "Represents recency or freshness of the product listing."218 },219 "discount": {220 "type": "number",221 "description": "Indicates the promotional value of a product."222 },223 "cancelled": {224 "type": "number",225 "description": "Reflects historical cancellation reliability of a product or seller."226 },227 "returns": {228 "type": "number",229 "description": "Measures post-purchase return behavior."230 },231 "catalogue": {232 "type": "number",233 "description": "Represents quality and completeness of catalog content."234 },235 "revenue": {236 "type": "number",237 "description": "Represents revenue contribution potential of a product."238 }239 }240 }241 },242 "required": [243 "weights"244 ]245 },246 "hyperactive_premium_repeat_customer": {247 "type": "object",248 "description": "Cohort-specific sorting configuration.",249 "properties": {250 "weights": {251 "type": "object",252 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",253 "properties": {254 "popularity": {255 "type": "number",256 "description": "Measures how widely a product is interacted with across users."257 },258 "availability": {259 "type": "number",260 "description": "Represents how readily a product can be fulfilled."261 },262 "conversion": {263 "type": "number",264 "description": "Indicates how effectively a product converts views into purchases."265 },266 "sold_quantity": {267 "type": "number",268 "description": "Reflects historical sales volume of a product."269 },270 "depth": {271 "type": "number",272 "description": "Measures size or variant depth of a product."273 },274 "listing": {275 "type": "number",276 "description": "Represents recency or freshness of the product listing."277 },278 "discount": {279 "type": "number",280 "description": "Indicates the promotional value of a product."281 },282 "cancelled": {283 "type": "number",284 "description": "Reflects historical cancellation reliability of a product or seller."285 },286 "returns": {287 "type": "number",288 "description": "Measures post-purchase return behavior."289 },290 "catalogue": {291 "type": "number",292 "description": "Represents quality and completeness of catalog content."293 },294 "revenue": {295 "type": "number",296 "description": "Represents revenue contribution potential of a product."297 }298 }299 }300 },301 "required": [302 "weights"303 ]304 },305 "high_spender_occasional_customer": {306 "type": "object",307 "description": "Cohort-specific sorting configuration.",308 "properties": {309 "weights": {310 "type": "object",311 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",312 "properties": {313 "popularity": {314 "type": "number",315 "description": "Measures how widely a product is interacted with across users."316 },317 "availability": {318 "type": "number",319 "description": "Represents how readily a product can be fulfilled."320 },321 "conversion": {322 "type": "number",323 "description": "Indicates how effectively a product converts views into purchases."324 },325 "sold_quantity": {326 "type": "number",327 "description": "Reflects historical sales volume of a product."328 },329 "depth": {330 "type": "number",331 "description": "Measures size or variant depth of a product."332 },333 "listing": {334 "type": "number",335 "description": "Represents recency or freshness of the product listing."336 },337 "discount": {338 "type": "number",339 "description": "Indicates the promotional value of a product."340 },341 "cancelled": {342 "type": "number",343 "description": "Reflects historical cancellation reliability of a product or seller."344 },345 "returns": {346 "type": "number",347 "description": "Measures post-purchase return behavior."348 },349 "catalogue": {350 "type": "number",351 "description": "Represents quality and completeness of catalog content."352 },353 "revenue": {354 "type": "number",355 "description": "Represents revenue contribution potential of a product."356 }357 }358 }359 },360 "required": [361 "weights"362 ]363 },364 "standard_occasional_customer": {365 "type": "object",366 "description": "Cohort-specific sorting configuration.",367 "properties": {368 "weights": {369 "type": "object",370 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",371 "properties": {372 "popularity": {373 "type": "number",374 "description": "Measures how widely a product is interacted with across users."375 },376 "availability": {377 "type": "number",378 "description": "Represents how readily a product can be fulfilled."379 },380 "conversion": {381 "type": "number",382 "description": "Indicates how effectively a product converts views into purchases."383 },384 "sold_quantity": {385 "type": "number",386 "description": "Reflects historical sales volume of a product."387 },388 "depth": {389 "type": "number",390 "description": "Measures size or variant depth of a product."391 },392 "listing": {393 "type": "number",394 "description": "Represents recency or freshness of the product listing."395 },396 "discount": {397 "type": "number",398 "description": "Indicates the promotional value of a product."399 },400 "cancelled": {401 "type": "number",402 "description": "Reflects historical cancellation reliability of a product or seller."403 },404 "returns": {405 "type": "number",406 "description": "Measures post-purchase return behavior."407 },408 "catalogue": {409 "type": "number",410 "description": "Represents quality and completeness of catalog content."411 },412 "revenue": {413 "type": "number",414 "description": "Represents revenue contribution potential of a product."415 }416 }417 }418 },419 "required": [420 "weights"421 ]422 },423 "dormant_premium_customer": {424 "type": "object",425 "description": "Cohort-specific sorting configuration.",426 "properties": {427 "weights": {428 "type": "object",429 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",430 "properties": {431 "popularity": {432 "type": "number",433 "description": "Measures how widely a product is interacted with across users."434 },435 "availability": {436 "type": "number",437 "description": "Represents how readily a product can be fulfilled."438 },439 "conversion": {440 "type": "number",441 "description": "Indicates how effectively a product converts views into purchases."442 },443 "sold_quantity": {444 "type": "number",445 "description": "Reflects historical sales volume of a product."446 },447 "depth": {448 "type": "number",449 "description": "Measures size or variant depth of a product."450 },451 "listing": {452 "type": "number",453 "description": "Represents recency or freshness of the product listing."454 },455 "discount": {456 "type": "number",457 "description": "Indicates the promotional value of a product."458 },459 "cancelled": {460 "type": "number",461 "description": "Reflects historical cancellation reliability of a product or seller."462 },463 "returns": {464 "type": "number",465 "description": "Measures post-purchase return behavior."466 },467 "catalogue": {468 "type": "number",469 "description": "Represents quality and completeness of catalog content."470 },471 "revenue": {472 "type": "number",473 "description": "Represents revenue contribution potential of a product."474 }475 }476 }477 },478 "required": [479 "weights"480 ]481 },482 "budget_regular_customer": {483 "type": "object",484 "description": "Cohort-specific sorting configuration.",485 "properties": {486 "weights": {487 "type": "object",488 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",489 "properties": {490 "popularity": {491 "type": "number",492 "description": "Measures how widely a product is interacted with across users."493 },494 "availability": {495 "type": "number",496 "description": "Represents how readily a product can be fulfilled."497 },498 "conversion": {499 "type": "number",500 "description": "Indicates how effectively a product converts views into purchases."501 },502 "sold_quantity": {503 "type": "number",504 "description": "Reflects historical sales volume of a product."505 },506 "depth": {507 "type": "number",508 "description": "Measures size or variant depth of a product."509 },510 "listing": {511 "type": "number",512 "description": "Represents recency or freshness of the product listing."513 },514 "discount": {515 "type": "number",516 "description": "Indicates the promotional value of a product."517 },518 "cancelled": {519 "type": "number",520 "description": "Reflects historical cancellation reliability of a product or seller."521 },522 "returns": {523 "type": "number",524 "description": "Measures post-purchase return behavior."525 },526 "catalogue": {527 "type": "number",528 "description": "Represents quality and completeness of catalog content."529 },530 "revenue": {531 "type": "number",532 "description": "Represents revenue contribution potential of a product."533 }534 }535 }536 },537 "required": [538 "weights"539 ]540 },541 "high_spender_regular_customer": {542 "type": "object",543 "description": "Cohort-specific sorting configuration.",544 "properties": {545 "weights": {546 "type": "object",547 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",548 "properties": {549 "popularity": {550 "type": "number",551 "description": "Measures how widely a product is interacted with across users."552 },553 "availability": {554 "type": "number",555 "description": "Represents how readily a product can be fulfilled."556 },557 "conversion": {558 "type": "number",559 "description": "Indicates how effectively a product converts views into purchases."560 },561 "sold_quantity": {562 "type": "number",563 "description": "Reflects historical sales volume of a product."564 },565 "depth": {566 "type": "number",567 "description": "Measures size or variant depth of a product."568 },569 "listing": {570 "type": "number",571 "description": "Represents recency or freshness of the product listing."572 },573 "discount": {574 "type": "number",575 "description": "Indicates the promotional value of a product."576 },577 "cancelled": {578 "type": "number",579 "description": "Reflects historical cancellation reliability of a product or seller."580 },581 "returns": {582 "type": "number",583 "description": "Measures post-purchase return behavior."584 },585 "catalogue": {586 "type": "number",587 "description": "Represents quality and completeness of catalog content."588 },589 "revenue": {590 "type": "number",591 "description": "Represents revenue contribution potential of a product."592 }593 }594 }595 },596 "required": [597 "weights"598 ]599 },600 "standard_customer_about_to_churn": {601 "type": "object",602 "description": "Cohort-specific sorting configuration.",603 "properties": {604 "weights": {605 "type": "object",606 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",607 "properties": {608 "popularity": {609 "type": "number",610 "description": "Measures how widely a product is interacted with across users."611 },612 "availability": {613 "type": "number",614 "description": "Represents how readily a product can be fulfilled."615 },616 "conversion": {617 "type": "number",618 "description": "Indicates how effectively a product converts views into purchases."619 },620 "sold_quantity": {621 "type": "number",622 "description": "Reflects historical sales volume of a product."623 },624 "depth": {625 "type": "number",626 "description": "Measures size or variant depth of a product."627 },628 "listing": {629 "type": "number",630 "description": "Represents recency or freshness of the product listing."631 },632 "discount": {633 "type": "number",634 "description": "Indicates the promotional value of a product."635 },636 "cancelled": {637 "type": "number",638 "description": "Reflects historical cancellation reliability of a product or seller."639 },640 "returns": {641 "type": "number",642 "description": "Measures post-purchase return behavior."643 },644 "catalogue": {645 "type": "number",646 "description": "Represents quality and completeness of catalog content."647 },648 "revenue": {649 "type": "number",650 "description": "Represents revenue contribution potential of a product."651 }652 }653 }654 },655 "required": [656 "weights"657 ]658 },659 "premium_customer_about_to_churn": {660 "type": "object",661 "description": "Cohort-specific sorting configuration.",662 "properties": {663 "weights": {664 "type": "object",665 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",666 "properties": {667 "popularity": {668 "type": "number",669 "description": "Measures how widely a product is interacted with across users."670 },671 "availability": {672 "type": "number",673 "description": "Represents how readily a product can be fulfilled."674 },675 "conversion": {676 "type": "number",677 "description": "Indicates how effectively a product converts views into purchases."678 },679 "sold_quantity": {680 "type": "number",681 "description": "Reflects historical sales volume of a product."682 },683 "depth": {684 "type": "number",685 "description": "Measures size or variant depth of a product."686 },687 "listing": {688 "type": "number",689 "description": "Represents recency or freshness of the product listing."690 },691 "discount": {692 "type": "number",693 "description": "Indicates the promotional value of a product."694 },695 "cancelled": {696 "type": "number",697 "description": "Reflects historical cancellation reliability of a product or seller."698 },699 "returns": {700 "type": "number",701 "description": "Measures post-purchase return behavior."702 },703 "catalogue": {704 "type": "number",705 "description": "Represents quality and completeness of catalog content."706 },707 "revenue": {708 "type": "number",709 "description": "Represents revenue contribution potential of a product."710 }711 }712 }713 },714 "required": [715 "weights"716 ]717 },718 "high_spender_customer_about_to_churn": {719 "type": "object",720 "description": "Cohort-specific sorting configuration.",721 "properties": {722 "weights": {723 "type": "object",724 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",725 "properties": {726 "popularity": {727 "type": "number",728 "description": "Measures how widely a product is interacted with across users."729 },730 "availability": {731 "type": "number",732 "description": "Represents how readily a product can be fulfilled."733 },734 "conversion": {735 "type": "number",736 "description": "Indicates how effectively a product converts views into purchases."737 },738 "sold_quantity": {739 "type": "number",740 "description": "Reflects historical sales volume of a product."741 },742 "depth": {743 "type": "number",744 "description": "Measures size or variant depth of a product."745 },746 "listing": {747 "type": "number",748 "description": "Represents recency or freshness of the product listing."749 },750 "discount": {751 "type": "number",752 "description": "Indicates the promotional value of a product."753 },754 "cancelled": {755 "type": "number",756 "description": "Reflects historical cancellation reliability of a product or seller."757 },758 "returns": {759 "type": "number",760 "description": "Measures post-purchase return behavior."761 },762 "catalogue": {763 "type": "number",764 "description": "Represents quality and completeness of catalog content."765 },766 "revenue": {767 "type": "number",768 "description": "Represents revenue contribution potential of a product."769 }770 }771 }772 },773 "required": [774 "weights"775 ]776 },777 "standard_dormant_customer": {778 "type": "object",779 "description": "Cohort-specific sorting configuration.",780 "properties": {781 "weights": {782 "type": "object",783 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",784 "properties": {785 "popularity": {786 "type": "number",787 "description": "Measures how widely a product is interacted with across users."788 },789 "availability": {790 "type": "number",791 "description": "Represents how readily a product can be fulfilled."792 },793 "conversion": {794 "type": "number",795 "description": "Indicates how effectively a product converts views into purchases."796 },797 "sold_quantity": {798 "type": "number",799 "description": "Reflects historical sales volume of a product."800 },801 "depth": {802 "type": "number",803 "description": "Measures size or variant depth of a product."804 },805 "listing": {806 "type": "number",807 "description": "Represents recency or freshness of the product listing."808 },809 "discount": {810 "type": "number",811 "description": "Indicates the promotional value of a product."812 },813 "cancelled": {814 "type": "number",815 "description": "Reflects historical cancellation reliability of a product or seller."816 },817 "returns": {818 "type": "number",819 "description": "Measures post-purchase return behavior."820 },821 "catalogue": {822 "type": "number",823 "description": "Represents quality and completeness of catalog content."824 },825 "revenue": {826 "type": "number",827 "description": "Represents revenue contribution potential of a product."828 }829 }830 }831 },832 "required": [833 "weights"834 ]835 },836 "high_spender_dormant_customer": {837 "type": "object",838 "description": "Cohort-specific sorting configuration.",839 "properties": {840 "weights": {841 "type": "object",842 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",843 "properties": {844 "popularity": {845 "type": "number",846 "description": "Measures how widely a product is interacted with across users."847 },848 "availability": {849 "type": "number",850 "description": "Represents how readily a product can be fulfilled."851 },852 "conversion": {853 "type": "number",854 "description": "Indicates how effectively a product converts views into purchases."855 },856 "sold_quantity": {857 "type": "number",858 "description": "Reflects historical sales volume of a product."859 },860 "depth": {861 "type": "number",862 "description": "Measures size or variant depth of a product."863 },864 "listing": {865 "type": "number",866 "description": "Represents recency or freshness of the product listing."867 },868 "discount": {869 "type": "number",870 "description": "Indicates the promotional value of a product."871 },872 "cancelled": {873 "type": "number",874 "description": "Reflects historical cancellation reliability of a product or seller."875 },876 "returns": {877 "type": "number",878 "description": "Measures post-purchase return behavior."879 },880 "catalogue": {881 "type": "number",882 "description": "Represents quality and completeness of catalog content."883 },884 "revenue": {885 "type": "number",886 "description": "Represents revenue contribution potential of a product."887 }888 }889 }890 },891 "required": [892 "weights"893 ]894 },895 "potential_customer": {896 "type": "object",897 "description": "Cohort-specific sorting configuration.",898 "properties": {899 "weights": {900 "type": "object",901 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",902 "properties": {903 "popularity": {904 "type": "number",905 "description": "Measures how widely a product is interacted with across users."906 },907 "availability": {908 "type": "number",909 "description": "Represents how readily a product can be fulfilled."910 },911 "conversion": {912 "type": "number",913 "description": "Indicates how effectively a product converts views into purchases."914 },915 "sold_quantity": {916 "type": "number",917 "description": "Reflects historical sales volume of a product."918 },919 "depth": {920 "type": "number",921 "description": "Measures size or variant depth of a product."922 },923 "listing": {924 "type": "number",925 "description": "Represents recency or freshness of the product listing."926 },927 "discount": {928 "type": "number",929 "description": "Indicates the promotional value of a product."930 },931 "cancelled": {932 "type": "number",933 "description": "Reflects historical cancellation reliability of a product or seller."934 },935 "returns": {936 "type": "number",937 "description": "Measures post-purchase return behavior."938 },939 "catalogue": {940 "type": "number",941 "description": "Represents quality and completeness of catalog content."942 },943 "revenue": {944 "type": "number",945 "description": "Represents revenue contribution potential of a product."946 }947 }948 }949 },950 "required": [951 "weights"952 ]953 },954 "new_customer": {955 "type": "object",956 "description": "Cohort-specific sorting configuration.",957 "properties": {958 "weights": {959 "type": "object",960 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",961 "properties": {962 "popularity": {963 "type": "number",964 "description": "Measures how widely a product is interacted with across users."965 },966 "availability": {967 "type": "number",968 "description": "Represents how readily a product can be fulfilled."969 },970 "conversion": {971 "type": "number",972 "description": "Indicates how effectively a product converts views into purchases."973 },974 "sold_quantity": {975 "type": "number",976 "description": "Reflects historical sales volume of a product."977 },978 "depth": {979 "type": "number",980 "description": "Measures size or variant depth of a product."981 },982 "listing": {983 "type": "number",984 "description": "Represents recency or freshness of the product listing."985 },986 "discount": {987 "type": "number",988 "description": "Indicates the promotional value of a product."989 },990 "cancelled": {991 "type": "number",992 "description": "Reflects historical cancellation reliability of a product or seller."993 },994 "returns": {995 "type": "number",996 "description": "Measures post-purchase return behavior."997 },998 "catalogue": {999 "type": "number",1000 "description": "Represents quality and completeness of catalog content."1001 },1002 "revenue": {1003 "type": "number",1004 "description": "Represents revenue contribution potential of a product."1005 }1006 }1007 }1008 },1009 "required": [1010 "weights"1011 ]1012 },1013 "budget_repeat_customer": {1014 "type": "object",1015 "description": "Cohort-specific sorting configuration.",1016 "properties": {1017 "weights": {1018 "type": "object",1019 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1020 "properties": {1021 "popularity": {1022 "type": "number",1023 "description": "Measures how widely a product is interacted with across users."1024 },1025 "availability": {1026 "type": "number",1027 "description": "Represents how readily a product can be fulfilled."1028 },1029 "conversion": {1030 "type": "number",1031 "description": "Indicates how effectively a product converts views into purchases."1032 },1033 "sold_quantity": {1034 "type": "number",1035 "description": "Reflects historical sales volume of a product."1036 },1037 "depth": {1038 "type": "number",1039 "description": "Measures size or variant depth of a product."1040 },1041 "listing": {1042 "type": "number",1043 "description": "Represents recency or freshness of the product listing."1044 },1045 "discount": {1046 "type": "number",1047 "description": "Indicates the promotional value of a product."1048 },1049 "cancelled": {1050 "type": "number",1051 "description": "Reflects historical cancellation reliability of a product or seller."1052 },1053 "returns": {1054 "type": "number",1055 "description": "Measures post-purchase return behavior."1056 },1057 "catalogue": {1058 "type": "number",1059 "description": "Represents quality and completeness of catalog content."1060 },1061 "revenue": {1062 "type": "number",1063 "description": "Represents revenue contribution potential of a product."1064 }1065 }1066 }1067 },1068 "required": [1069 "weights"1070 ]1071 },1072 "average_spender_repeat_customer": {1073 "type": "object",1074 "description": "Cohort-specific sorting configuration.",1075 "properties": {1076 "weights": {1077 "type": "object",1078 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1079 "properties": {1080 "popularity": {1081 "type": "number",1082 "description": "Measures how widely a product is interacted with across users."1083 },1084 "availability": {1085 "type": "number",1086 "description": "Represents how readily a product can be fulfilled."1087 },1088 "conversion": {1089 "type": "number",1090 "description": "Indicates how effectively a product converts views into purchases."1091 },1092 "sold_quantity": {1093 "type": "number",1094 "description": "Reflects historical sales volume of a product."1095 },1096 "depth": {1097 "type": "number",1098 "description": "Measures size or variant depth of a product."1099 },1100 "listing": {1101 "type": "number",1102 "description": "Represents recency or freshness of the product listing."1103 },1104 "discount": {1105 "type": "number",1106 "description": "Indicates the promotional value of a product."1107 },1108 "cancelled": {1109 "type": "number",1110 "description": "Reflects historical cancellation reliability of a product or seller."1111 },1112 "returns": {1113 "type": "number",1114 "description": "Measures post-purchase return behavior."1115 },1116 "catalogue": {1117 "type": "number",1118 "description": "Represents quality and completeness of catalog content."1119 },1120 "revenue": {1121 "type": "number",1122 "description": "Represents revenue contribution potential of a product."1123 }1124 }1125 }1126 },1127 "required": [1128 "weights"1129 ]1130 }1131 }1132 }1133 },1134 "description": ""1135 }1136 }1137 }1138 }1139}
Payload Example
1{2 "event": {3 "trace_id": [4 "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"5 ],6 "name": "sort",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712260100414,10 "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 26130,15 "application_id": [16 "660edfcaaaaa57fb0b439b31",17 "*"18 ],19 "contains": [20 "sort"21 ],22 "payload": {23 "sort": {24 "id": "660f03f6b83b58237cc2e8de",25 "is_active": true,26 "key": "best_selling",27 "name": "Best Selling Products",28 "is_default": false,29 "priority": 1,30 "default_key": "popular",31 "logo": "/addsale/misc/default-assets/original/best-selling.png",32 "app_id": "660edfcaaaaa57fb0b439b31",33 "weights": {34 "revenue": 50,35 "conversion": 30,36 "popularity": 2037 },38 "cohorts": {39 "high_spender_repeat_customer": {40 "weights": {41 "revenue": 50,42 "conversion": 30,43 "popularity": 2044 }45 },46 "potential_customer": {47 "weights": {48 "popularity": 60,49 "discount": 4050 }51 }52 }53 }54 }55}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
weights
object
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
cohorts
object
Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.
Properties
high_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
hyperactive_premium_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
dormant_premium_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
premium_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
potential_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
new_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
average_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "sort"78 ],79 "properties": {80 "sort": {81 "type": "object",82 "required": [83 "app_id",84 "id",85 "key",86 "is_active",87 "priority",88 "is_default",89 "default_key",90 "name"91 ],92 "properties": {93 "id": {94 "type": "string",95 "description": "UUID of the sort config."96 },97 "key": {98 "type": "string",99 "description": "Slug of the sort attribute."100 },101 "logo": {102 "type": "string",103 "description": "Logo to show for the sort in the configuration."104 },105 "name": {106 "type": "string",107 "description": "Display Name of the Sort config."108 },109 "app_id": {110 "type": "string",111 "description": "Unique ID of the application."112 },113 "priority": {114 "type": "integer",115 "description": "Position of the Sort config."116 },117 "is_active": {118 "type": "boolean",119 "description": "Active status of the sort config."120 },121 "is_default": {122 "type": "boolean",123 "description": "Default sorting values from the system."124 },125 "default_key": {126 "type": "string",127 "description": "The default sort key"128 },129 "display_name": {130 "type": "string",131 "description": "Name to be displayed on the storefront in the sorting options."132 },133 "weights": {134 "type": "object",135 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",136 "properties": {137 "popularity": {138 "type": "number",139 "description": "Measures how widely a product is interacted with across users."140 },141 "availability": {142 "type": "number",143 "description": "Represents how readily a product can be fulfilled."144 },145 "conversion": {146 "type": "number",147 "description": "Indicates how effectively a product converts views into purchases."148 },149 "sold_quantity": {150 "type": "number",151 "description": "Reflects historical sales volume of a product."152 },153 "depth": {154 "type": "number",155 "description": "Measures size or variant depth of a product."156 },157 "listing": {158 "type": "number",159 "description": "Represents recency or freshness of the product listing."160 },161 "discount": {162 "type": "number",163 "description": "Indicates the promotional value of a product."164 },165 "cancelled": {166 "type": "number",167 "description": "Reflects historical cancellation reliability of a product or seller."168 },169 "returns": {170 "type": "number",171 "description": "Measures post-purchase return behavior."172 },173 "catalogue": {174 "type": "number",175 "description": "Represents quality and completeness of catalog content."176 },177 "revenue": {178 "type": "number",179 "description": "Represents revenue contribution potential of a product."180 }181 }182 },183 "cohorts": {184 "type": "object",185 "description": "Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.",186 "properties": {187 "high_spender_repeat_customer": {188 "type": "object",189 "description": "Cohort-specific sorting configuration.",190 "properties": {191 "weights": {192 "type": "object",193 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",194 "properties": {195 "popularity": {196 "type": "number",197 "description": "Measures how widely a product is interacted with across users."198 },199 "availability": {200 "type": "number",201 "description": "Represents how readily a product can be fulfilled."202 },203 "conversion": {204 "type": "number",205 "description": "Indicates how effectively a product converts views into purchases."206 },207 "sold_quantity": {208 "type": "number",209 "description": "Reflects historical sales volume of a product."210 },211 "depth": {212 "type": "number",213 "description": "Measures size or variant depth of a product."214 },215 "listing": {216 "type": "number",217 "description": "Represents recency or freshness of the product listing."218 },219 "discount": {220 "type": "number",221 "description": "Indicates the promotional value of a product."222 },223 "cancelled": {224 "type": "number",225 "description": "Reflects historical cancellation reliability of a product or seller."226 },227 "returns": {228 "type": "number",229 "description": "Measures post-purchase return behavior."230 },231 "catalogue": {232 "type": "number",233 "description": "Represents quality and completeness of catalog content."234 },235 "revenue": {236 "type": "number",237 "description": "Represents revenue contribution potential of a product."238 }239 }240 }241 },242 "required": [243 "weights"244 ]245 },246 "hyperactive_premium_repeat_customer": {247 "type": "object",248 "description": "Cohort-specific sorting configuration.",249 "properties": {250 "weights": {251 "type": "object",252 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",253 "properties": {254 "popularity": {255 "type": "number",256 "description": "Measures how widely a product is interacted with across users."257 },258 "availability": {259 "type": "number",260 "description": "Represents how readily a product can be fulfilled."261 },262 "conversion": {263 "type": "number",264 "description": "Indicates how effectively a product converts views into purchases."265 },266 "sold_quantity": {267 "type": "number",268 "description": "Reflects historical sales volume of a product."269 },270 "depth": {271 "type": "number",272 "description": "Measures size or variant depth of a product."273 },274 "listing": {275 "type": "number",276 "description": "Represents recency or freshness of the product listing."277 },278 "discount": {279 "type": "number",280 "description": "Indicates the promotional value of a product."281 },282 "cancelled": {283 "type": "number",284 "description": "Reflects historical cancellation reliability of a product or seller."285 },286 "returns": {287 "type": "number",288 "description": "Measures post-purchase return behavior."289 },290 "catalogue": {291 "type": "number",292 "description": "Represents quality and completeness of catalog content."293 },294 "revenue": {295 "type": "number",296 "description": "Represents revenue contribution potential of a product."297 }298 }299 }300 },301 "required": [302 "weights"303 ]304 },305 "high_spender_occasional_customer": {306 "type": "object",307 "description": "Cohort-specific sorting configuration.",308 "properties": {309 "weights": {310 "type": "object",311 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",312 "properties": {313 "popularity": {314 "type": "number",315 "description": "Measures how widely a product is interacted with across users."316 },317 "availability": {318 "type": "number",319 "description": "Represents how readily a product can be fulfilled."320 },321 "conversion": {322 "type": "number",323 "description": "Indicates how effectively a product converts views into purchases."324 },325 "sold_quantity": {326 "type": "number",327 "description": "Reflects historical sales volume of a product."328 },329 "depth": {330 "type": "number",331 "description": "Measures size or variant depth of a product."332 },333 "listing": {334 "type": "number",335 "description": "Represents recency or freshness of the product listing."336 },337 "discount": {338 "type": "number",339 "description": "Indicates the promotional value of a product."340 },341 "cancelled": {342 "type": "number",343 "description": "Reflects historical cancellation reliability of a product or seller."344 },345 "returns": {346 "type": "number",347 "description": "Measures post-purchase return behavior."348 },349 "catalogue": {350 "type": "number",351 "description": "Represents quality and completeness of catalog content."352 },353 "revenue": {354 "type": "number",355 "description": "Represents revenue contribution potential of a product."356 }357 }358 }359 },360 "required": [361 "weights"362 ]363 },364 "standard_occasional_customer": {365 "type": "object",366 "description": "Cohort-specific sorting configuration.",367 "properties": {368 "weights": {369 "type": "object",370 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",371 "properties": {372 "popularity": {373 "type": "number",374 "description": "Measures how widely a product is interacted with across users."375 },376 "availability": {377 "type": "number",378 "description": "Represents how readily a product can be fulfilled."379 },380 "conversion": {381 "type": "number",382 "description": "Indicates how effectively a product converts views into purchases."383 },384 "sold_quantity": {385 "type": "number",386 "description": "Reflects historical sales volume of a product."387 },388 "depth": {389 "type": "number",390 "description": "Measures size or variant depth of a product."391 },392 "listing": {393 "type": "number",394 "description": "Represents recency or freshness of the product listing."395 },396 "discount": {397 "type": "number",398 "description": "Indicates the promotional value of a product."399 },400 "cancelled": {401 "type": "number",402 "description": "Reflects historical cancellation reliability of a product or seller."403 },404 "returns": {405 "type": "number",406 "description": "Measures post-purchase return behavior."407 },408 "catalogue": {409 "type": "number",410 "description": "Represents quality and completeness of catalog content."411 },412 "revenue": {413 "type": "number",414 "description": "Represents revenue contribution potential of a product."415 }416 }417 }418 },419 "required": [420 "weights"421 ]422 },423 "dormant_premium_customer": {424 "type": "object",425 "description": "Cohort-specific sorting configuration.",426 "properties": {427 "weights": {428 "type": "object",429 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",430 "properties": {431 "popularity": {432 "type": "number",433 "description": "Measures how widely a product is interacted with across users."434 },435 "availability": {436 "type": "number",437 "description": "Represents how readily a product can be fulfilled."438 },439 "conversion": {440 "type": "number",441 "description": "Indicates how effectively a product converts views into purchases."442 },443 "sold_quantity": {444 "type": "number",445 "description": "Reflects historical sales volume of a product."446 },447 "depth": {448 "type": "number",449 "description": "Measures size or variant depth of a product."450 },451 "listing": {452 "type": "number",453 "description": "Represents recency or freshness of the product listing."454 },455 "discount": {456 "type": "number",457 "description": "Indicates the promotional value of a product."458 },459 "cancelled": {460 "type": "number",461 "description": "Reflects historical cancellation reliability of a product or seller."462 },463 "returns": {464 "type": "number",465 "description": "Measures post-purchase return behavior."466 },467 "catalogue": {468 "type": "number",469 "description": "Represents quality and completeness of catalog content."470 },471 "revenue": {472 "type": "number",473 "description": "Represents revenue contribution potential of a product."474 }475 }476 }477 },478 "required": [479 "weights"480 ]481 },482 "budget_regular_customer": {483 "type": "object",484 "description": "Cohort-specific sorting configuration.",485 "properties": {486 "weights": {487 "type": "object",488 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",489 "properties": {490 "popularity": {491 "type": "number",492 "description": "Measures how widely a product is interacted with across users."493 },494 "availability": {495 "type": "number",496 "description": "Represents how readily a product can be fulfilled."497 },498 "conversion": {499 "type": "number",500 "description": "Indicates how effectively a product converts views into purchases."501 },502 "sold_quantity": {503 "type": "number",504 "description": "Reflects historical sales volume of a product."505 },506 "depth": {507 "type": "number",508 "description": "Measures size or variant depth of a product."509 },510 "listing": {511 "type": "number",512 "description": "Represents recency or freshness of the product listing."513 },514 "discount": {515 "type": "number",516 "description": "Indicates the promotional value of a product."517 },518 "cancelled": {519 "type": "number",520 "description": "Reflects historical cancellation reliability of a product or seller."521 },522 "returns": {523 "type": "number",524 "description": "Measures post-purchase return behavior."525 },526 "catalogue": {527 "type": "number",528 "description": "Represents quality and completeness of catalog content."529 },530 "revenue": {531 "type": "number",532 "description": "Represents revenue contribution potential of a product."533 }534 }535 }536 },537 "required": [538 "weights"539 ]540 },541 "high_spender_regular_customer": {542 "type": "object",543 "description": "Cohort-specific sorting configuration.",544 "properties": {545 "weights": {546 "type": "object",547 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",548 "properties": {549 "popularity": {550 "type": "number",551 "description": "Measures how widely a product is interacted with across users."552 },553 "availability": {554 "type": "number",555 "description": "Represents how readily a product can be fulfilled."556 },557 "conversion": {558 "type": "number",559 "description": "Indicates how effectively a product converts views into purchases."560 },561 "sold_quantity": {562 "type": "number",563 "description": "Reflects historical sales volume of a product."564 },565 "depth": {566 "type": "number",567 "description": "Measures size or variant depth of a product."568 },569 "listing": {570 "type": "number",571 "description": "Represents recency or freshness of the product listing."572 },573 "discount": {574 "type": "number",575 "description": "Indicates the promotional value of a product."576 },577 "cancelled": {578 "type": "number",579 "description": "Reflects historical cancellation reliability of a product or seller."580 },581 "returns": {582 "type": "number",583 "description": "Measures post-purchase return behavior."584 },585 "catalogue": {586 "type": "number",587 "description": "Represents quality and completeness of catalog content."588 },589 "revenue": {590 "type": "number",591 "description": "Represents revenue contribution potential of a product."592 }593 }594 }595 },596 "required": [597 "weights"598 ]599 },600 "standard_customer_about_to_churn": {601 "type": "object",602 "description": "Cohort-specific sorting configuration.",603 "properties": {604 "weights": {605 "type": "object",606 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",607 "properties": {608 "popularity": {609 "type": "number",610 "description": "Measures how widely a product is interacted with across users."611 },612 "availability": {613 "type": "number",614 "description": "Represents how readily a product can be fulfilled."615 },616 "conversion": {617 "type": "number",618 "description": "Indicates how effectively a product converts views into purchases."619 },620 "sold_quantity": {621 "type": "number",622 "description": "Reflects historical sales volume of a product."623 },624 "depth": {625 "type": "number",626 "description": "Measures size or variant depth of a product."627 },628 "listing": {629 "type": "number",630 "description": "Represents recency or freshness of the product listing."631 },632 "discount": {633 "type": "number",634 "description": "Indicates the promotional value of a product."635 },636 "cancelled": {637 "type": "number",638 "description": "Reflects historical cancellation reliability of a product or seller."639 },640 "returns": {641 "type": "number",642 "description": "Measures post-purchase return behavior."643 },644 "catalogue": {645 "type": "number",646 "description": "Represents quality and completeness of catalog content."647 },648 "revenue": {649 "type": "number",650 "description": "Represents revenue contribution potential of a product."651 }652 }653 }654 },655 "required": [656 "weights"657 ]658 },659 "premium_customer_about_to_churn": {660 "type": "object",661 "description": "Cohort-specific sorting configuration.",662 "properties": {663 "weights": {664 "type": "object",665 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",666 "properties": {667 "popularity": {668 "type": "number",669 "description": "Measures how widely a product is interacted with across users."670 },671 "availability": {672 "type": "number",673 "description": "Represents how readily a product can be fulfilled."674 },675 "conversion": {676 "type": "number",677 "description": "Indicates how effectively a product converts views into purchases."678 },679 "sold_quantity": {680 "type": "number",681 "description": "Reflects historical sales volume of a product."682 },683 "depth": {684 "type": "number",685 "description": "Measures size or variant depth of a product."686 },687 "listing": {688 "type": "number",689 "description": "Represents recency or freshness of the product listing."690 },691 "discount": {692 "type": "number",693 "description": "Indicates the promotional value of a product."694 },695 "cancelled": {696 "type": "number",697 "description": "Reflects historical cancellation reliability of a product or seller."698 },699 "returns": {700 "type": "number",701 "description": "Measures post-purchase return behavior."702 },703 "catalogue": {704 "type": "number",705 "description": "Represents quality and completeness of catalog content."706 },707 "revenue": {708 "type": "number",709 "description": "Represents revenue contribution potential of a product."710 }711 }712 }713 },714 "required": [715 "weights"716 ]717 },718 "high_spender_customer_about_to_churn": {719 "type": "object",720 "description": "Cohort-specific sorting configuration.",721 "properties": {722 "weights": {723 "type": "object",724 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",725 "properties": {726 "popularity": {727 "type": "number",728 "description": "Measures how widely a product is interacted with across users."729 },730 "availability": {731 "type": "number",732 "description": "Represents how readily a product can be fulfilled."733 },734 "conversion": {735 "type": "number",736 "description": "Indicates how effectively a product converts views into purchases."737 },738 "sold_quantity": {739 "type": "number",740 "description": "Reflects historical sales volume of a product."741 },742 "depth": {743 "type": "number",744 "description": "Measures size or variant depth of a product."745 },746 "listing": {747 "type": "number",748 "description": "Represents recency or freshness of the product listing."749 },750 "discount": {751 "type": "number",752 "description": "Indicates the promotional value of a product."753 },754 "cancelled": {755 "type": "number",756 "description": "Reflects historical cancellation reliability of a product or seller."757 },758 "returns": {759 "type": "number",760 "description": "Measures post-purchase return behavior."761 },762 "catalogue": {763 "type": "number",764 "description": "Represents quality and completeness of catalog content."765 },766 "revenue": {767 "type": "number",768 "description": "Represents revenue contribution potential of a product."769 }770 }771 }772 },773 "required": [774 "weights"775 ]776 },777 "standard_dormant_customer": {778 "type": "object",779 "description": "Cohort-specific sorting configuration.",780 "properties": {781 "weights": {782 "type": "object",783 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",784 "properties": {785 "popularity": {786 "type": "number",787 "description": "Measures how widely a product is interacted with across users."788 },789 "availability": {790 "type": "number",791 "description": "Represents how readily a product can be fulfilled."792 },793 "conversion": {794 "type": "number",795 "description": "Indicates how effectively a product converts views into purchases."796 },797 "sold_quantity": {798 "type": "number",799 "description": "Reflects historical sales volume of a product."800 },801 "depth": {802 "type": "number",803 "description": "Measures size or variant depth of a product."804 },805 "listing": {806 "type": "number",807 "description": "Represents recency or freshness of the product listing."808 },809 "discount": {810 "type": "number",811 "description": "Indicates the promotional value of a product."812 },813 "cancelled": {814 "type": "number",815 "description": "Reflects historical cancellation reliability of a product or seller."816 },817 "returns": {818 "type": "number",819 "description": "Measures post-purchase return behavior."820 },821 "catalogue": {822 "type": "number",823 "description": "Represents quality and completeness of catalog content."824 },825 "revenue": {826 "type": "number",827 "description": "Represents revenue contribution potential of a product."828 }829 }830 }831 },832 "required": [833 "weights"834 ]835 },836 "high_spender_dormant_customer": {837 "type": "object",838 "description": "Cohort-specific sorting configuration.",839 "properties": {840 "weights": {841 "type": "object",842 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",843 "properties": {844 "popularity": {845 "type": "number",846 "description": "Measures how widely a product is interacted with across users."847 },848 "availability": {849 "type": "number",850 "description": "Represents how readily a product can be fulfilled."851 },852 "conversion": {853 "type": "number",854 "description": "Indicates how effectively a product converts views into purchases."855 },856 "sold_quantity": {857 "type": "number",858 "description": "Reflects historical sales volume of a product."859 },860 "depth": {861 "type": "number",862 "description": "Measures size or variant depth of a product."863 },864 "listing": {865 "type": "number",866 "description": "Represents recency or freshness of the product listing."867 },868 "discount": {869 "type": "number",870 "description": "Indicates the promotional value of a product."871 },872 "cancelled": {873 "type": "number",874 "description": "Reflects historical cancellation reliability of a product or seller."875 },876 "returns": {877 "type": "number",878 "description": "Measures post-purchase return behavior."879 },880 "catalogue": {881 "type": "number",882 "description": "Represents quality and completeness of catalog content."883 },884 "revenue": {885 "type": "number",886 "description": "Represents revenue contribution potential of a product."887 }888 }889 }890 },891 "required": [892 "weights"893 ]894 },895 "potential_customer": {896 "type": "object",897 "description": "Cohort-specific sorting configuration.",898 "properties": {899 "weights": {900 "type": "object",901 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",902 "properties": {903 "popularity": {904 "type": "number",905 "description": "Measures how widely a product is interacted with across users."906 },907 "availability": {908 "type": "number",909 "description": "Represents how readily a product can be fulfilled."910 },911 "conversion": {912 "type": "number",913 "description": "Indicates how effectively a product converts views into purchases."914 },915 "sold_quantity": {916 "type": "number",917 "description": "Reflects historical sales volume of a product."918 },919 "depth": {920 "type": "number",921 "description": "Measures size or variant depth of a product."922 },923 "listing": {924 "type": "number",925 "description": "Represents recency or freshness of the product listing."926 },927 "discount": {928 "type": "number",929 "description": "Indicates the promotional value of a product."930 },931 "cancelled": {932 "type": "number",933 "description": "Reflects historical cancellation reliability of a product or seller."934 },935 "returns": {936 "type": "number",937 "description": "Measures post-purchase return behavior."938 },939 "catalogue": {940 "type": "number",941 "description": "Represents quality and completeness of catalog content."942 },943 "revenue": {944 "type": "number",945 "description": "Represents revenue contribution potential of a product."946 }947 }948 }949 },950 "required": [951 "weights"952 ]953 },954 "new_customer": {955 "type": "object",956 "description": "Cohort-specific sorting configuration.",957 "properties": {958 "weights": {959 "type": "object",960 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",961 "properties": {962 "popularity": {963 "type": "number",964 "description": "Measures how widely a product is interacted with across users."965 },966 "availability": {967 "type": "number",968 "description": "Represents how readily a product can be fulfilled."969 },970 "conversion": {971 "type": "number",972 "description": "Indicates how effectively a product converts views into purchases."973 },974 "sold_quantity": {975 "type": "number",976 "description": "Reflects historical sales volume of a product."977 },978 "depth": {979 "type": "number",980 "description": "Measures size or variant depth of a product."981 },982 "listing": {983 "type": "number",984 "description": "Represents recency or freshness of the product listing."985 },986 "discount": {987 "type": "number",988 "description": "Indicates the promotional value of a product."989 },990 "cancelled": {991 "type": "number",992 "description": "Reflects historical cancellation reliability of a product or seller."993 },994 "returns": {995 "type": "number",996 "description": "Measures post-purchase return behavior."997 },998 "catalogue": {999 "type": "number",1000 "description": "Represents quality and completeness of catalog content."1001 },1002 "revenue": {1003 "type": "number",1004 "description": "Represents revenue contribution potential of a product."1005 }1006 }1007 }1008 },1009 "required": [1010 "weights"1011 ]1012 },1013 "budget_repeat_customer": {1014 "type": "object",1015 "description": "Cohort-specific sorting configuration.",1016 "properties": {1017 "weights": {1018 "type": "object",1019 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1020 "properties": {1021 "popularity": {1022 "type": "number",1023 "description": "Measures how widely a product is interacted with across users."1024 },1025 "availability": {1026 "type": "number",1027 "description": "Represents how readily a product can be fulfilled."1028 },1029 "conversion": {1030 "type": "number",1031 "description": "Indicates how effectively a product converts views into purchases."1032 },1033 "sold_quantity": {1034 "type": "number",1035 "description": "Reflects historical sales volume of a product."1036 },1037 "depth": {1038 "type": "number",1039 "description": "Measures size or variant depth of a product."1040 },1041 "listing": {1042 "type": "number",1043 "description": "Represents recency or freshness of the product listing."1044 },1045 "discount": {1046 "type": "number",1047 "description": "Indicates the promotional value of a product."1048 },1049 "cancelled": {1050 "type": "number",1051 "description": "Reflects historical cancellation reliability of a product or seller."1052 },1053 "returns": {1054 "type": "number",1055 "description": "Measures post-purchase return behavior."1056 },1057 "catalogue": {1058 "type": "number",1059 "description": "Represents quality and completeness of catalog content."1060 },1061 "revenue": {1062 "type": "number",1063 "description": "Represents revenue contribution potential of a product."1064 }1065 }1066 }1067 },1068 "required": [1069 "weights"1070 ]1071 },1072 "average_spender_repeat_customer": {1073 "type": "object",1074 "description": "Cohort-specific sorting configuration.",1075 "properties": {1076 "weights": {1077 "type": "object",1078 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1079 "properties": {1080 "popularity": {1081 "type": "number",1082 "description": "Measures how widely a product is interacted with across users."1083 },1084 "availability": {1085 "type": "number",1086 "description": "Represents how readily a product can be fulfilled."1087 },1088 "conversion": {1089 "type": "number",1090 "description": "Indicates how effectively a product converts views into purchases."1091 },1092 "sold_quantity": {1093 "type": "number",1094 "description": "Reflects historical sales volume of a product."1095 },1096 "depth": {1097 "type": "number",1098 "description": "Measures size or variant depth of a product."1099 },1100 "listing": {1101 "type": "number",1102 "description": "Represents recency or freshness of the product listing."1103 },1104 "discount": {1105 "type": "number",1106 "description": "Indicates the promotional value of a product."1107 },1108 "cancelled": {1109 "type": "number",1110 "description": "Reflects historical cancellation reliability of a product or seller."1111 },1112 "returns": {1113 "type": "number",1114 "description": "Measures post-purchase return behavior."1115 },1116 "catalogue": {1117 "type": "number",1118 "description": "Represents quality and completeness of catalog content."1119 },1120 "revenue": {1121 "type": "number",1122 "description": "Represents revenue contribution potential of a product."1123 }1124 }1125 }1126 },1127 "required": [1128 "weights"1129 ]1130 }1131 }1132 }1133 },1134 "description": ""1135 }1136 }1137 }1138 }1139}
Payload Example
1{2 "event": {3 "trace_id": [4 "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"5 ],6 "name": "sort",7 "type": "update",8 "version": "1",9 "created_timestamp": 1712260100414,10 "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 26130,15 "application_id": [16 "660edfcaaaaa57fb0b439b31",17 "*"18 ],19 "contains": [20 "sort"21 ],22 "payload": {23 "sort": {24 "id": "660f03f6b83b58237cc2e8de",25 "is_active": true,26 "key": "best_selling",27 "name": "Best Selling Products",28 "is_default": false,29 "priority": 1,30 "default_key": "popular",31 "logo": "/addsale/misc/default-assets/original/best-selling.png",32 "app_id": "660edfcaaaaa57fb0b439b31",33 "weights": {34 "revenue": 50,35 "conversion": 30,36 "popularity": 2037 },38 "cohorts": {39 "high_spender_repeat_customer": {40 "weights": {41 "revenue": 50,42 "conversion": 30,43 "popularity": 2044 }45 },46 "potential_customer": {47 "weights": {48 "popularity": 60,49 "discount": 4050 }51 }52 }53 }54 }55}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
weights
object
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
cohorts
object
Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.
Properties
high_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
hyperactive_premium_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_occasional_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
dormant_premium_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_regular_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
premium_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_customer_about_to_churn
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
standard_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
high_spender_dormant_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
potential_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
new_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
budget_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
average_spender_repeat_customer
object
Cohort-specific sorting configuration.
Properties
weights
object
Required
Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.
Properties
popularity
number
Measures how widely a product is interacted with across users.
availability
number
Represents how readily a product can be fulfilled.
conversion
number
Indicates how effectively a product converts views into purchases.
sold_quantity
number
Reflects historical sales volume of a product.
depth
number
Measures size or variant depth of a product.
listing
number
Represents recency or freshness of the product listing.
discount
number
Indicates the promotional value of a product.
cancelled
number
Reflects historical cancellation reliability of a product or seller.
returns
number
Measures post-purchase return behavior.
catalogue
number
Represents quality and completeness of catalog content.
revenue
number
Represents revenue contribution potential of a product.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "sort"78 ],79 "properties": {80 "sort": {81 "type": "object",82 "required": [83 "app_id",84 "id",85 "key",86 "is_active",87 "priority",88 "is_default",89 "default_key",90 "name"91 ],92 "properties": {93 "id": {94 "type": "string",95 "description": "UUID of the sort config."96 },97 "key": {98 "type": "string",99 "description": "Slug of the sort attribute."100 },101 "logo": {102 "type": "string",103 "description": "Logo to show for the sort in the configuration."104 },105 "name": {106 "type": "string",107 "description": "Display Name of the Sort config."108 },109 "app_id": {110 "type": "string",111 "description": "Unique ID of the application."112 },113 "priority": {114 "type": "integer",115 "description": "Position of the Sort config."116 },117 "is_active": {118 "type": "boolean",119 "description": "Active status of the sort config."120 },121 "is_default": {122 "type": "boolean",123 "description": "Default sorting values from the system."124 },125 "default_key": {126 "type": "string",127 "description": "The default sort key"128 },129 "display_name": {130 "type": "string",131 "description": "Name to be displayed on the storefront in the sorting options."132 },133 "weights": {134 "type": "object",135 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",136 "properties": {137 "popularity": {138 "type": "number",139 "description": "Measures how widely a product is interacted with across users."140 },141 "availability": {142 "type": "number",143 "description": "Represents how readily a product can be fulfilled."144 },145 "conversion": {146 "type": "number",147 "description": "Indicates how effectively a product converts views into purchases."148 },149 "sold_quantity": {150 "type": "number",151 "description": "Reflects historical sales volume of a product."152 },153 "depth": {154 "type": "number",155 "description": "Measures size or variant depth of a product."156 },157 "listing": {158 "type": "number",159 "description": "Represents recency or freshness of the product listing."160 },161 "discount": {162 "type": "number",163 "description": "Indicates the promotional value of a product."164 },165 "cancelled": {166 "type": "number",167 "description": "Reflects historical cancellation reliability of a product or seller."168 },169 "returns": {170 "type": "number",171 "description": "Measures post-purchase return behavior."172 },173 "catalogue": {174 "type": "number",175 "description": "Represents quality and completeness of catalog content."176 },177 "revenue": {178 "type": "number",179 "description": "Represents revenue contribution potential of a product."180 }181 }182 },183 "cohorts": {184 "type": "object",185 "description": "Mapping of customer cohorts to their specific sorting weights. Each property represents a customer cohort with its own weight configuration override.",186 "properties": {187 "high_spender_repeat_customer": {188 "type": "object",189 "description": "Cohort-specific sorting configuration.",190 "properties": {191 "weights": {192 "type": "object",193 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",194 "properties": {195 "popularity": {196 "type": "number",197 "description": "Measures how widely a product is interacted with across users."198 },199 "availability": {200 "type": "number",201 "description": "Represents how readily a product can be fulfilled."202 },203 "conversion": {204 "type": "number",205 "description": "Indicates how effectively a product converts views into purchases."206 },207 "sold_quantity": {208 "type": "number",209 "description": "Reflects historical sales volume of a product."210 },211 "depth": {212 "type": "number",213 "description": "Measures size or variant depth of a product."214 },215 "listing": {216 "type": "number",217 "description": "Represents recency or freshness of the product listing."218 },219 "discount": {220 "type": "number",221 "description": "Indicates the promotional value of a product."222 },223 "cancelled": {224 "type": "number",225 "description": "Reflects historical cancellation reliability of a product or seller."226 },227 "returns": {228 "type": "number",229 "description": "Measures post-purchase return behavior."230 },231 "catalogue": {232 "type": "number",233 "description": "Represents quality and completeness of catalog content."234 },235 "revenue": {236 "type": "number",237 "description": "Represents revenue contribution potential of a product."238 }239 }240 }241 },242 "required": [243 "weights"244 ]245 },246 "hyperactive_premium_repeat_customer": {247 "type": "object",248 "description": "Cohort-specific sorting configuration.",249 "properties": {250 "weights": {251 "type": "object",252 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",253 "properties": {254 "popularity": {255 "type": "number",256 "description": "Measures how widely a product is interacted with across users."257 },258 "availability": {259 "type": "number",260 "description": "Represents how readily a product can be fulfilled."261 },262 "conversion": {263 "type": "number",264 "description": "Indicates how effectively a product converts views into purchases."265 },266 "sold_quantity": {267 "type": "number",268 "description": "Reflects historical sales volume of a product."269 },270 "depth": {271 "type": "number",272 "description": "Measures size or variant depth of a product."273 },274 "listing": {275 "type": "number",276 "description": "Represents recency or freshness of the product listing."277 },278 "discount": {279 "type": "number",280 "description": "Indicates the promotional value of a product."281 },282 "cancelled": {283 "type": "number",284 "description": "Reflects historical cancellation reliability of a product or seller."285 },286 "returns": {287 "type": "number",288 "description": "Measures post-purchase return behavior."289 },290 "catalogue": {291 "type": "number",292 "description": "Represents quality and completeness of catalog content."293 },294 "revenue": {295 "type": "number",296 "description": "Represents revenue contribution potential of a product."297 }298 }299 }300 },301 "required": [302 "weights"303 ]304 },305 "high_spender_occasional_customer": {306 "type": "object",307 "description": "Cohort-specific sorting configuration.",308 "properties": {309 "weights": {310 "type": "object",311 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",312 "properties": {313 "popularity": {314 "type": "number",315 "description": "Measures how widely a product is interacted with across users."316 },317 "availability": {318 "type": "number",319 "description": "Represents how readily a product can be fulfilled."320 },321 "conversion": {322 "type": "number",323 "description": "Indicates how effectively a product converts views into purchases."324 },325 "sold_quantity": {326 "type": "number",327 "description": "Reflects historical sales volume of a product."328 },329 "depth": {330 "type": "number",331 "description": "Measures size or variant depth of a product."332 },333 "listing": {334 "type": "number",335 "description": "Represents recency or freshness of the product listing."336 },337 "discount": {338 "type": "number",339 "description": "Indicates the promotional value of a product."340 },341 "cancelled": {342 "type": "number",343 "description": "Reflects historical cancellation reliability of a product or seller."344 },345 "returns": {346 "type": "number",347 "description": "Measures post-purchase return behavior."348 },349 "catalogue": {350 "type": "number",351 "description": "Represents quality and completeness of catalog content."352 },353 "revenue": {354 "type": "number",355 "description": "Represents revenue contribution potential of a product."356 }357 }358 }359 },360 "required": [361 "weights"362 ]363 },364 "standard_occasional_customer": {365 "type": "object",366 "description": "Cohort-specific sorting configuration.",367 "properties": {368 "weights": {369 "type": "object",370 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",371 "properties": {372 "popularity": {373 "type": "number",374 "description": "Measures how widely a product is interacted with across users."375 },376 "availability": {377 "type": "number",378 "description": "Represents how readily a product can be fulfilled."379 },380 "conversion": {381 "type": "number",382 "description": "Indicates how effectively a product converts views into purchases."383 },384 "sold_quantity": {385 "type": "number",386 "description": "Reflects historical sales volume of a product."387 },388 "depth": {389 "type": "number",390 "description": "Measures size or variant depth of a product."391 },392 "listing": {393 "type": "number",394 "description": "Represents recency or freshness of the product listing."395 },396 "discount": {397 "type": "number",398 "description": "Indicates the promotional value of a product."399 },400 "cancelled": {401 "type": "number",402 "description": "Reflects historical cancellation reliability of a product or seller."403 },404 "returns": {405 "type": "number",406 "description": "Measures post-purchase return behavior."407 },408 "catalogue": {409 "type": "number",410 "description": "Represents quality and completeness of catalog content."411 },412 "revenue": {413 "type": "number",414 "description": "Represents revenue contribution potential of a product."415 }416 }417 }418 },419 "required": [420 "weights"421 ]422 },423 "dormant_premium_customer": {424 "type": "object",425 "description": "Cohort-specific sorting configuration.",426 "properties": {427 "weights": {428 "type": "object",429 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",430 "properties": {431 "popularity": {432 "type": "number",433 "description": "Measures how widely a product is interacted with across users."434 },435 "availability": {436 "type": "number",437 "description": "Represents how readily a product can be fulfilled."438 },439 "conversion": {440 "type": "number",441 "description": "Indicates how effectively a product converts views into purchases."442 },443 "sold_quantity": {444 "type": "number",445 "description": "Reflects historical sales volume of a product."446 },447 "depth": {448 "type": "number",449 "description": "Measures size or variant depth of a product."450 },451 "listing": {452 "type": "number",453 "description": "Represents recency or freshness of the product listing."454 },455 "discount": {456 "type": "number",457 "description": "Indicates the promotional value of a product."458 },459 "cancelled": {460 "type": "number",461 "description": "Reflects historical cancellation reliability of a product or seller."462 },463 "returns": {464 "type": "number",465 "description": "Measures post-purchase return behavior."466 },467 "catalogue": {468 "type": "number",469 "description": "Represents quality and completeness of catalog content."470 },471 "revenue": {472 "type": "number",473 "description": "Represents revenue contribution potential of a product."474 }475 }476 }477 },478 "required": [479 "weights"480 ]481 },482 "budget_regular_customer": {483 "type": "object",484 "description": "Cohort-specific sorting configuration.",485 "properties": {486 "weights": {487 "type": "object",488 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",489 "properties": {490 "popularity": {491 "type": "number",492 "description": "Measures how widely a product is interacted with across users."493 },494 "availability": {495 "type": "number",496 "description": "Represents how readily a product can be fulfilled."497 },498 "conversion": {499 "type": "number",500 "description": "Indicates how effectively a product converts views into purchases."501 },502 "sold_quantity": {503 "type": "number",504 "description": "Reflects historical sales volume of a product."505 },506 "depth": {507 "type": "number",508 "description": "Measures size or variant depth of a product."509 },510 "listing": {511 "type": "number",512 "description": "Represents recency or freshness of the product listing."513 },514 "discount": {515 "type": "number",516 "description": "Indicates the promotional value of a product."517 },518 "cancelled": {519 "type": "number",520 "description": "Reflects historical cancellation reliability of a product or seller."521 },522 "returns": {523 "type": "number",524 "description": "Measures post-purchase return behavior."525 },526 "catalogue": {527 "type": "number",528 "description": "Represents quality and completeness of catalog content."529 },530 "revenue": {531 "type": "number",532 "description": "Represents revenue contribution potential of a product."533 }534 }535 }536 },537 "required": [538 "weights"539 ]540 },541 "high_spender_regular_customer": {542 "type": "object",543 "description": "Cohort-specific sorting configuration.",544 "properties": {545 "weights": {546 "type": "object",547 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",548 "properties": {549 "popularity": {550 "type": "number",551 "description": "Measures how widely a product is interacted with across users."552 },553 "availability": {554 "type": "number",555 "description": "Represents how readily a product can be fulfilled."556 },557 "conversion": {558 "type": "number",559 "description": "Indicates how effectively a product converts views into purchases."560 },561 "sold_quantity": {562 "type": "number",563 "description": "Reflects historical sales volume of a product."564 },565 "depth": {566 "type": "number",567 "description": "Measures size or variant depth of a product."568 },569 "listing": {570 "type": "number",571 "description": "Represents recency or freshness of the product listing."572 },573 "discount": {574 "type": "number",575 "description": "Indicates the promotional value of a product."576 },577 "cancelled": {578 "type": "number",579 "description": "Reflects historical cancellation reliability of a product or seller."580 },581 "returns": {582 "type": "number",583 "description": "Measures post-purchase return behavior."584 },585 "catalogue": {586 "type": "number",587 "description": "Represents quality and completeness of catalog content."588 },589 "revenue": {590 "type": "number",591 "description": "Represents revenue contribution potential of a product."592 }593 }594 }595 },596 "required": [597 "weights"598 ]599 },600 "standard_customer_about_to_churn": {601 "type": "object",602 "description": "Cohort-specific sorting configuration.",603 "properties": {604 "weights": {605 "type": "object",606 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",607 "properties": {608 "popularity": {609 "type": "number",610 "description": "Measures how widely a product is interacted with across users."611 },612 "availability": {613 "type": "number",614 "description": "Represents how readily a product can be fulfilled."615 },616 "conversion": {617 "type": "number",618 "description": "Indicates how effectively a product converts views into purchases."619 },620 "sold_quantity": {621 "type": "number",622 "description": "Reflects historical sales volume of a product."623 },624 "depth": {625 "type": "number",626 "description": "Measures size or variant depth of a product."627 },628 "listing": {629 "type": "number",630 "description": "Represents recency or freshness of the product listing."631 },632 "discount": {633 "type": "number",634 "description": "Indicates the promotional value of a product."635 },636 "cancelled": {637 "type": "number",638 "description": "Reflects historical cancellation reliability of a product or seller."639 },640 "returns": {641 "type": "number",642 "description": "Measures post-purchase return behavior."643 },644 "catalogue": {645 "type": "number",646 "description": "Represents quality and completeness of catalog content."647 },648 "revenue": {649 "type": "number",650 "description": "Represents revenue contribution potential of a product."651 }652 }653 }654 },655 "required": [656 "weights"657 ]658 },659 "premium_customer_about_to_churn": {660 "type": "object",661 "description": "Cohort-specific sorting configuration.",662 "properties": {663 "weights": {664 "type": "object",665 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",666 "properties": {667 "popularity": {668 "type": "number",669 "description": "Measures how widely a product is interacted with across users."670 },671 "availability": {672 "type": "number",673 "description": "Represents how readily a product can be fulfilled."674 },675 "conversion": {676 "type": "number",677 "description": "Indicates how effectively a product converts views into purchases."678 },679 "sold_quantity": {680 "type": "number",681 "description": "Reflects historical sales volume of a product."682 },683 "depth": {684 "type": "number",685 "description": "Measures size or variant depth of a product."686 },687 "listing": {688 "type": "number",689 "description": "Represents recency or freshness of the product listing."690 },691 "discount": {692 "type": "number",693 "description": "Indicates the promotional value of a product."694 },695 "cancelled": {696 "type": "number",697 "description": "Reflects historical cancellation reliability of a product or seller."698 },699 "returns": {700 "type": "number",701 "description": "Measures post-purchase return behavior."702 },703 "catalogue": {704 "type": "number",705 "description": "Represents quality and completeness of catalog content."706 },707 "revenue": {708 "type": "number",709 "description": "Represents revenue contribution potential of a product."710 }711 }712 }713 },714 "required": [715 "weights"716 ]717 },718 "high_spender_customer_about_to_churn": {719 "type": "object",720 "description": "Cohort-specific sorting configuration.",721 "properties": {722 "weights": {723 "type": "object",724 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",725 "properties": {726 "popularity": {727 "type": "number",728 "description": "Measures how widely a product is interacted with across users."729 },730 "availability": {731 "type": "number",732 "description": "Represents how readily a product can be fulfilled."733 },734 "conversion": {735 "type": "number",736 "description": "Indicates how effectively a product converts views into purchases."737 },738 "sold_quantity": {739 "type": "number",740 "description": "Reflects historical sales volume of a product."741 },742 "depth": {743 "type": "number",744 "description": "Measures size or variant depth of a product."745 },746 "listing": {747 "type": "number",748 "description": "Represents recency or freshness of the product listing."749 },750 "discount": {751 "type": "number",752 "description": "Indicates the promotional value of a product."753 },754 "cancelled": {755 "type": "number",756 "description": "Reflects historical cancellation reliability of a product or seller."757 },758 "returns": {759 "type": "number",760 "description": "Measures post-purchase return behavior."761 },762 "catalogue": {763 "type": "number",764 "description": "Represents quality and completeness of catalog content."765 },766 "revenue": {767 "type": "number",768 "description": "Represents revenue contribution potential of a product."769 }770 }771 }772 },773 "required": [774 "weights"775 ]776 },777 "standard_dormant_customer": {778 "type": "object",779 "description": "Cohort-specific sorting configuration.",780 "properties": {781 "weights": {782 "type": "object",783 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",784 "properties": {785 "popularity": {786 "type": "number",787 "description": "Measures how widely a product is interacted with across users."788 },789 "availability": {790 "type": "number",791 "description": "Represents how readily a product can be fulfilled."792 },793 "conversion": {794 "type": "number",795 "description": "Indicates how effectively a product converts views into purchases."796 },797 "sold_quantity": {798 "type": "number",799 "description": "Reflects historical sales volume of a product."800 },801 "depth": {802 "type": "number",803 "description": "Measures size or variant depth of a product."804 },805 "listing": {806 "type": "number",807 "description": "Represents recency or freshness of the product listing."808 },809 "discount": {810 "type": "number",811 "description": "Indicates the promotional value of a product."812 },813 "cancelled": {814 "type": "number",815 "description": "Reflects historical cancellation reliability of a product or seller."816 },817 "returns": {818 "type": "number",819 "description": "Measures post-purchase return behavior."820 },821 "catalogue": {822 "type": "number",823 "description": "Represents quality and completeness of catalog content."824 },825 "revenue": {826 "type": "number",827 "description": "Represents revenue contribution potential of a product."828 }829 }830 }831 },832 "required": [833 "weights"834 ]835 },836 "high_spender_dormant_customer": {837 "type": "object",838 "description": "Cohort-specific sorting configuration.",839 "properties": {840 "weights": {841 "type": "object",842 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",843 "properties": {844 "popularity": {845 "type": "number",846 "description": "Measures how widely a product is interacted with across users."847 },848 "availability": {849 "type": "number",850 "description": "Represents how readily a product can be fulfilled."851 },852 "conversion": {853 "type": "number",854 "description": "Indicates how effectively a product converts views into purchases."855 },856 "sold_quantity": {857 "type": "number",858 "description": "Reflects historical sales volume of a product."859 },860 "depth": {861 "type": "number",862 "description": "Measures size or variant depth of a product."863 },864 "listing": {865 "type": "number",866 "description": "Represents recency or freshness of the product listing."867 },868 "discount": {869 "type": "number",870 "description": "Indicates the promotional value of a product."871 },872 "cancelled": {873 "type": "number",874 "description": "Reflects historical cancellation reliability of a product or seller."875 },876 "returns": {877 "type": "number",878 "description": "Measures post-purchase return behavior."879 },880 "catalogue": {881 "type": "number",882 "description": "Represents quality and completeness of catalog content."883 },884 "revenue": {885 "type": "number",886 "description": "Represents revenue contribution potential of a product."887 }888 }889 }890 },891 "required": [892 "weights"893 ]894 },895 "potential_customer": {896 "type": "object",897 "description": "Cohort-specific sorting configuration.",898 "properties": {899 "weights": {900 "type": "object",901 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",902 "properties": {903 "popularity": {904 "type": "number",905 "description": "Measures how widely a product is interacted with across users."906 },907 "availability": {908 "type": "number",909 "description": "Represents how readily a product can be fulfilled."910 },911 "conversion": {912 "type": "number",913 "description": "Indicates how effectively a product converts views into purchases."914 },915 "sold_quantity": {916 "type": "number",917 "description": "Reflects historical sales volume of a product."918 },919 "depth": {920 "type": "number",921 "description": "Measures size or variant depth of a product."922 },923 "listing": {924 "type": "number",925 "description": "Represents recency or freshness of the product listing."926 },927 "discount": {928 "type": "number",929 "description": "Indicates the promotional value of a product."930 },931 "cancelled": {932 "type": "number",933 "description": "Reflects historical cancellation reliability of a product or seller."934 },935 "returns": {936 "type": "number",937 "description": "Measures post-purchase return behavior."938 },939 "catalogue": {940 "type": "number",941 "description": "Represents quality and completeness of catalog content."942 },943 "revenue": {944 "type": "number",945 "description": "Represents revenue contribution potential of a product."946 }947 }948 }949 },950 "required": [951 "weights"952 ]953 },954 "new_customer": {955 "type": "object",956 "description": "Cohort-specific sorting configuration.",957 "properties": {958 "weights": {959 "type": "object",960 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",961 "properties": {962 "popularity": {963 "type": "number",964 "description": "Measures how widely a product is interacted with across users."965 },966 "availability": {967 "type": "number",968 "description": "Represents how readily a product can be fulfilled."969 },970 "conversion": {971 "type": "number",972 "description": "Indicates how effectively a product converts views into purchases."973 },974 "sold_quantity": {975 "type": "number",976 "description": "Reflects historical sales volume of a product."977 },978 "depth": {979 "type": "number",980 "description": "Measures size or variant depth of a product."981 },982 "listing": {983 "type": "number",984 "description": "Represents recency or freshness of the product listing."985 },986 "discount": {987 "type": "number",988 "description": "Indicates the promotional value of a product."989 },990 "cancelled": {991 "type": "number",992 "description": "Reflects historical cancellation reliability of a product or seller."993 },994 "returns": {995 "type": "number",996 "description": "Measures post-purchase return behavior."997 },998 "catalogue": {999 "type": "number",1000 "description": "Represents quality and completeness of catalog content."1001 },1002 "revenue": {1003 "type": "number",1004 "description": "Represents revenue contribution potential of a product."1005 }1006 }1007 }1008 },1009 "required": [1010 "weights"1011 ]1012 },1013 "budget_repeat_customer": {1014 "type": "object",1015 "description": "Cohort-specific sorting configuration.",1016 "properties": {1017 "weights": {1018 "type": "object",1019 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1020 "properties": {1021 "popularity": {1022 "type": "number",1023 "description": "Measures how widely a product is interacted with across users."1024 },1025 "availability": {1026 "type": "number",1027 "description": "Represents how readily a product can be fulfilled."1028 },1029 "conversion": {1030 "type": "number",1031 "description": "Indicates how effectively a product converts views into purchases."1032 },1033 "sold_quantity": {1034 "type": "number",1035 "description": "Reflects historical sales volume of a product."1036 },1037 "depth": {1038 "type": "number",1039 "description": "Measures size or variant depth of a product."1040 },1041 "listing": {1042 "type": "number",1043 "description": "Represents recency or freshness of the product listing."1044 },1045 "discount": {1046 "type": "number",1047 "description": "Indicates the promotional value of a product."1048 },1049 "cancelled": {1050 "type": "number",1051 "description": "Reflects historical cancellation reliability of a product or seller."1052 },1053 "returns": {1054 "type": "number",1055 "description": "Measures post-purchase return behavior."1056 },1057 "catalogue": {1058 "type": "number",1059 "description": "Represents quality and completeness of catalog content."1060 },1061 "revenue": {1062 "type": "number",1063 "description": "Represents revenue contribution potential of a product."1064 }1065 }1066 }1067 },1068 "required": [1069 "weights"1070 ]1071 },1072 "average_spender_repeat_customer": {1073 "type": "object",1074 "description": "Cohort-specific sorting configuration.",1075 "properties": {1076 "weights": {1077 "type": "object",1078 "description": "Weight percentages (0-100) for sorting parameters. The final score is a weighted sum.",1079 "properties": {1080 "popularity": {1081 "type": "number",1082 "description": "Measures how widely a product is interacted with across users."1083 },1084 "availability": {1085 "type": "number",1086 "description": "Represents how readily a product can be fulfilled."1087 },1088 "conversion": {1089 "type": "number",1090 "description": "Indicates how effectively a product converts views into purchases."1091 },1092 "sold_quantity": {1093 "type": "number",1094 "description": "Reflects historical sales volume of a product."1095 },1096 "depth": {1097 "type": "number",1098 "description": "Measures size or variant depth of a product."1099 },1100 "listing": {1101 "type": "number",1102 "description": "Represents recency or freshness of the product listing."1103 },1104 "discount": {1105 "type": "number",1106 "description": "Indicates the promotional value of a product."1107 },1108 "cancelled": {1109 "type": "number",1110 "description": "Reflects historical cancellation reliability of a product or seller."1111 },1112 "returns": {1113 "type": "number",1114 "description": "Measures post-purchase return behavior."1115 },1116 "catalogue": {1117 "type": "number",1118 "description": "Represents quality and completeness of catalog content."1119 },1120 "revenue": {1121 "type": "number",1122 "description": "Represents revenue contribution potential of a product."1123 }1124 }1125 }1126 },1127 "required": [1128 "weights"1129 ]1130 }1131 }1132 }1133 },1134 "description": ""1135 }1136 }1137 }1138 }1139}
Payload Example
1{2 "event": {3 "trace_id": [4 "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"5 ],6 "name": "sort",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1712260082824,10 "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 26130,15 "application_id": [16 "660edfcaaaaa57fb0b439b31",17 "*"18 ],19 "contains": [20 "sort"21 ],22 "payload": {23 "sort": {24 "name": "Best Selling Products",25 "is_default": false,26 "key": "best_selling",27 "is_active": true,28 "default_key": "popular",29 "priority": 1,30 "logo": "/addsale/misc/default-assets/original/best-selling.png",31 "app_id": "660edfcaaaaa57fb0b439b31",32 "id": "660f03f243ec2f1db3288646",33 "weights": {34 "revenue": 50,35 "conversion": 30,36 "popularity": 2037 },38 "cohorts": {39 "high_spender_repeat_customer": {40 "weights": {41 "revenue": 50,42 "conversion": 30,43 "popularity": 2044 }45 }46 }47 }48 }49}