Application

1{
2  "type": "object",
3  "description": "This event is triggered when offer is created",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "Company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "Category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "Event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "Internal trace_id for Fynd Commerce services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "offer"
81      ],
82      "properties": {
83        "offer": {
84          "type": "object",
85          "description": "The offer data",
86          "required": [
87            "_id",
88            "mode",
89            "application_id",
90            "display_meta",
91            "author",
92            "date_meta",
93            "type",
94            "calculate_on",
95            "published",
96            "status"
97          ],
98          "properties": {
99            "_id": {
100              "type": "string",
101              "description": "Unique identifier of offer"
102            },
103            "mode": {
104              "type": "string",
105              "description": "Offer mode, like coupon or promotion",
106              "enum": [
107                "promotion",
108                "coupon"
109              ]
110            },
111            "status": {
112              "type": "string",
113              "description": "Status of the offer",
114              "enum": [
115                "draft",
116                "approved",
117                "rejected",
118                "scheduled"
119              ]
120            },
121            "published": {
122              "type": "boolean",
123              "description": "Determines whether the offer is published to customers or marked inactive"
124            },
125            "coupon_config": {
126              "type": "object",
127              "description": "Bulk configuration for the offer",
128              "properties": {
129                "coupon_count": {
130                  "type": "integer",
131                  "description": "Total number of coupons to be generated when coupon type is bulk"
132                },
133                "coupon_prefix": {
134                  "type": "string",
135                  "description": "Bulk coupon code prefix string. All coupons will be generated with this prefix."
136                },
137                "coupon_type": {
138                  "type": "string",
139                  "description": "The type of coupon like bulk or single.",
140                  "enum": [
141                    "bulk",
142                    "single"
143                  ]
144                }
145              }
146            },
147            "auto_apply": {
148              "type": "boolean",
149              "description": "Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required."
150            },
151            "application_id": {
152              "type": "string",
153              "description": "Application id through which offer was created"
154            },
155            "company_id": {
156              "type": "string",
157              "description": "Company id through which offer was created"
158            },
159            "discount_rules": {
160              "type": "array",
161              "description": "Discount rules based on which offer will be applied",
162              "maxItems": 10,
163              "items": {
164                "type": "object",
165                "properties": {
166                  "discount_type": {
167                    "type": "string",
168                    "description": "The type of discount in offer",
169                    "enum": [
170                      "percentage",
171                      "amount",
172                      "fixed_price",
173                      "fixed_unit_price",
174                      "bogo",
175                      "shipping_price",
176                      "cashback",
177                      "coupon_code",
178                      "free_items",
179                      "free_gift_items",
180                      "free_non_sellable_items",
181                      "item_based_discount",
182                      "bundle"
183                    ]
184                  },
185                  "buy_condition": {
186                    "type": "string",
187                    "description": "Offer buy rules in offer level"
188                  },
189                  "item_criteria": {
190                    "type": "object",
191                    "description": "Filter offer applicability",
192                    "properties": {
193                      "category_id": {
194                        "type": "array",
195                        "description": "List of category id available for offer",
196                        "items": {
197                          "type": "integer",
198                          "format": "int32"
199                        }
200                      },
201                      "collection_id": {
202                        "type": "array",
203                        "description": "List of collection id available for offer",
204                        "items": {
205                          "type": "string"
206                        }
207                      },
208                      "all_items": {
209                        "description": "Boolean flag determining if offer is applicable on all offers",
210                        "type": "boolean"
211                      },
212                      "item_brand": {
213                        "type": "array",
214                        "description": "List of all brand ids on which promotion is applicable",
215                        "items": {
216                          "type": "integer",
217                          "format": "int32"
218                        }
219                      },
220                      "article_ids": {
221                        "type": "array",
222                        "description": "List of unique identifier of articles on which offer will be applicable",
223                        "items": {
224                          "type": "string"
225                        }
226                      },
227                      "item_sku": {
228                        "type": "array",
229                        "description": "List of all item sku on which promotion is applicable",
230                        "items": {
231                          "type": "string"
232                        }
233                      },
234                      "item_id": {
235                        "type": "array",
236                        "description": "List of all item ids on which offer is applicable",
237                        "items": {
238                          "type": "integer",
239                          "format": "int32"
240                        }
241                      },
242                      "item_l1_category": {
243                        "type": "array",
244                        "description": "List of all L1 category on which offer is applicable",
245                        "items": {
246                          "type": "integer",
247                          "format": "int32",
248                          "x-not-enum": true
249                        }
250                      },
251                      "item_l2_category": {
252                        "type": "array",
253                        "description": "List of all L2 category on which offer is applicable",
254                        "items": {
255                          "type": "integer",
256                          "format": "int32",
257                          "x-not-enum": true
258                        }
259                      },
260                      "item_category": {
261                        "type": "array",
262                        "description": "List of all L3 category on which offer is applicable",
263                        "items": {
264                          "type": "integer",
265                          "format": "int32",
266                          "x-not-enum": true
267                        }
268                      },
269                      "item_department": {
270                        "type": "array",
271                        "description": "List of all departments ids on which offer is applicable",
272                        "items": {
273                          "type": "integer",
274                          "format": "int32"
275                        }
276                      },
277                      "item_store": {
278                        "type": "array",
279                        "description": "List of all item store ids on which offer is applicable",
280                        "items": {
281                          "type": "integer",
282                          "format": "int32"
283                        }
284                      },
285                      "item_size": {
286                        "type": "array",
287                        "description": "List of all item sizes on which offer is applicable",
288                        "items": {
289                          "type": "string"
290                        }
291                      },
292                      "item_company": {
293                        "type": "array",
294                        "description": "List of all company ids on which offer is applicable",
295                        "items": {
296                          "type": "integer",
297                          "format": "int32"
298                        }
299                      },
300                      "item_tags": {
301                        "type": "array",
302                        "description": "List of all product tags on which offer is applicable",
303                        "items": {
304                          "type": "string"
305                        }
306                      },
307                      "cart_quantity": {
308                        "type": "object",
309                        "description": "Manage operator and their value for cart rules in promotion",
310                        "properties": {
311                          "equals": {
312                            "type": [
313                              "number",
314                              null
315                            ],
316                            "format": "float",
317                            "nullable": true,
318                            "description": "Nummeric value must be equal to cart level rules"
319                          },
320                          "greater_than": {
321                            "type": [
322                              "number",
323                              null
324                            ],
325                            "format": "float",
326                            "nullable": true,
327                            "description": "Nummeric value must be greater than cart level rules"
328                          },
329                          "less_than_equals": {
330                            "type": [
331                              "number",
332                              null
333                            ],
334                            "format": "float",
335                            "nullable": true,
336                            "description": "Nummeric value must be less than or equal to cart level rules"
337                          },
338                          "less_than": {
339                            "type": [
340                              "number",
341                              null
342                            ],
343                            "format": "float",
344                            "nullable": true,
345                            "description": "Nummeric value must be less than cart level rules"
346                          },
347                          "greater_than_equals": {
348                            "type": [
349                              "number",
350                              null
351                            ],
352                            "format": "float",
353                            "nullable": true,
354                            "description": "Nummeric value must be greater than or equal to cart level rules"
355                          }
356                        }
357                      },
358                      "cart_total": {
359                        "type": "object",
360                        "description": "Manage operator and their value for cart rules in promotion",
361                        "properties": {
362                          "equals": {
363                            "type": [
364                              "number",
365                              null
366                            ],
367                            "format": "float",
368                            "nullable": true,
369                            "description": "Nummeric value must be equal to cart level rules"
370                          },
371                          "greater_than": {
372                            "type": [
373                              "number",
374                              null
375                            ],
376                            "format": "float",
377                            "nullable": true,
378                            "description": "Nummeric value must be greater than cart level rules"
379                          },
380                          "less_than_equals": {
381                            "type": [
382                              "number",
383                              null
384                            ],
385                            "format": "float",
386                            "nullable": true,
387                            "description": "Nummeric value must be less than or equal to cart level rules"
388                          },
389                          "less_than": {
390                            "type": [
391                              "number",
392                              null
393                            ],
394                            "format": "float",
395                            "nullable": true,
396                            "description": "Nummeric value must be less than cart level rules"
397                          },
398                          "greater_than_equals": {
399                            "type": [
400                              "number",
401                              null
402                            ],
403                            "format": "float",
404                            "nullable": true,
405                            "description": "Nummeric value must be greater than or equal to cart level rules"
406                          }
407                        }
408                      },
409                      "item_exclude_l1_category": {
410                        "type": "array",
411                        "description": "List of all L1 categories on which offer is not applicable",
412                        "items": {
413                          "type": "integer",
414                          "format": "int32",
415                          "x-not-enum": true
416                        }
417                      },
418                      "item_exclude_l2_category": {
419                        "type": "array",
420                        "description": "List of all L2 categories on which offer is not applicable",
421                        "items": {
422                          "type": "integer",
423                          "format": "int32",
424                          "x-not-enum": true
425                        }
426                      },
427                      "item_exclude_category": {
428                        "type": "array",
429                        "description": "List of all L3 categories on which offer is not applicable",
430                        "items": {
431                          "type": "integer",
432                          "format": "int32",
433                          "x-not-enum": true
434                        }
435                      },
436                      "cart_unique_item_quantity": {
437                        "type": "object",
438                        "description": "Manage operator and their value for cart rules in promotion",
439                        "properties": {
440                          "equals": {
441                            "type": [
442                              "number",
443                              null
444                            ],
445                            "format": "float",
446                            "nullable": true,
447                            "description": "Nummeric value must be equal to cart level rules"
448                          },
449                          "greater_than": {
450                            "type": [
451                              "number",
452                              null
453                            ],
454                            "format": "float",
455                            "nullable": true,
456                            "description": "Nummeric value must be greater than cart level rules"
457                          },
458                          "less_than_equals": {
459                            "type": [
460                              "number",
461                              null
462                            ],
463                            "format": "float",
464                            "nullable": true,
465                            "description": "Nummeric value must be less than or equal to cart level rules"
466                          },
467                          "less_than": {
468                            "type": [
469                              "number",
470                              null
471                            ],
472                            "format": "float",
473                            "nullable": true,
474                            "description": "Nummeric value must be less than cart level rules"
475                          },
476                          "greater_than_equals": {
477                            "type": [
478                              "number",
479                              null
480                            ],
481                            "format": "float",
482                            "nullable": true,
483                            "description": "Nummeric value must be greater than or equal to cart level rules"
484                          }
485                        }
486                      },
487                      "cart_unique_item_amount": {
488                        "type": "object",
489                        "description": "Manage operator and their value for cart rules in promotion",
490                        "properties": {
491                          "equals": {
492                            "type": [
493                              "number",
494                              null
495                            ],
496                            "format": "float",
497                            "nullable": true,
498                            "description": "Nummeric value must be equal to cart level rules"
499                          },
500                          "greater_than": {
501                            "type": [
502                              "number",
503                              null
504                            ],
505                            "format": "float",
506                            "nullable": true,
507                            "description": "Nummeric value must be greater than cart level rules"
508                          },
509                          "less_than_equals": {
510                            "type": [
511                              "number",
512                              null
513                            ],
514                            "format": "float",
515                            "nullable": true,
516                            "description": "Nummeric value must be less than or equal to cart level rules"
517                          },
518                          "less_than": {
519                            "type": [
520                              "number",
521                              null
522                            ],
523                            "format": "float",
524                            "nullable": true,
525                            "description": "Nummeric value must be less than cart level rules"
526                          },
527                          "greater_than_equals": {
528                            "type": [
529                              "number",
530                              null
531                            ],
532                            "format": "float",
533                            "nullable": true,
534                            "description": "Nummeric value must be greater than or equal to cart level rules"
535                          }
536                        }
537                      },
538                      "item_exclude_department": {
539                        "type": "array",
540                        "description": "List of all department ids on which offer is not applicable",
541                        "items": {
542                          "type": "integer",
543                          "format": "int32"
544                        }
545                      },
546                      "item_exclude_store": {
547                        "type": "array",
548                        "description": "List of all item store ids on which offer is not applicable",
549                        "items": {
550                          "type": "integer",
551                          "format": "int32"
552                        }
553                      },
554                      "item_exclude_brand": {
555                        "type": "array",
556                        "description": "List of all brand ids on which offer is not applicable",
557                        "items": {
558                          "type": "integer",
559                          "format": "int32"
560                        }
561                      },
562                      "item_exclude_sku": {
563                        "type": "array",
564                        "description": "List of all item sku on which offer is not applicable",
565                        "items": {
566                          "type": "string"
567                        }
568                      },
569                      "item_exclude_company": {
570                        "type": "array",
571                        "description": "List of all company id on which offer is not applicable",
572                        "items": {
573                          "type": "integer",
574                          "format": "int32"
575                        }
576                      },
577                      "available_zones": {
578                        "type": "array",
579                        "description": "List of all zones on which offer is applicable",
580                        "items": {
581                          "type": "string"
582                        }
583                      },
584                      "item_exclude_id": {
585                        "type": "array",
586                        "description": "List of all item ids on which offer is not applicable",
587                        "items": {
588                          "type": "integer",
589                          "format": "int32"
590                        }
591                      },
592                      "buy_rules": {
593                        "type": "array",
594                        "description": "List of buy rules that is applicable for this offer",
595                        "items": {
596                          "type": "string"
597                        }
598                      },
599                      "item_size_mapping": {
600                        "type": "object",
601                        "description": "Map size with product in promotion",
602                        "properties": {
603                          "item_size_mapping": {
604                            "type": "object",
605                            "description": "Item size mapping in promotion",
606                            "additionalProperties": true
607                          }
608                        }
609                      }
610                    }
611                  },
612                  "offer": {
613                    "type": "object",
614                    "description": "Defines the discount details for the offer. The required fields vary dynamically based on the discount type. For example, for a percentage-based discount, the `discount_percentage` field is mandatory. For quantity-based discounts, fields such as `max_offer_quantity` or `min_offer_quantity` become mandatory.\n",
615                    "properties": {
616                      "max_discount_amount": {
617                        "type": "number",
618                        "format": "float",
619                        "description": "Maximum discount amount in offer"
620                      },
621                      "discount_price": {
622                        "type": "number",
623                        "format": "float",
624                        "description": "Discount price in offer"
625                      },
626                      "apportion_discount": {
627                        "type": "boolean",
628                        "description": "Flag to distribute discount for each article"
629                      },
630                      "partial_can_ret": {
631                        "type": "boolean",
632                        "description": "Flag indicated return the product partially"
633                      },
634                      "max_usage_per_transaction": {
635                        "type": [
636                          "integer",
637                          null
638                        ],
639                        "format": "int32",
640                        "nullable": true,
641                        "description": "Maximum usage per transaction in offer"
642                      },
643                      "min_offer_quantity": {
644                        "type": [
645                          "integer",
646                          null
647                        ],
648                        "format": "int32",
649                        "description": "Minimum quantity of offer in offer"
650                      },
651                      "discount_amount": {
652                        "type": "number",
653                        "format": "float",
654                        "description": "Discount amount in offer"
655                      },
656                      "discount_percentage": {
657                        "type": [
658                          "number",
659                          null
660                        ],
661                        "format": "float",
662                        "nullable": true,
663                        "description": "Discount percentage in offer"
664                      },
665                      "max_offer_quantity": {
666                        "type": "integer",
667                        "format": "int32",
668                        "description": "Maximum quantity of product in offer"
669                      }
670                    }
671                  },
672                  "is_exact": {
673                    "type": "boolean",
674                    "description": "Flag is true then use coupon applicable articles for calculation"
675                  }
676                }
677              }
678            },
679            "buy_rules": {
680              "type": "object",
681              "description": "Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.\n",
682              "maxProperties": 10,
683              "additionalProperties": {
684                "type": "object",
685                "description": "Filter offer applicability",
686                "properties": {
687                  "category_id": {
688                    "type": "array",
689                    "description": "List of category id available for offer",
690                    "items": {
691                      "type": "integer",
692                      "format": "int32"
693                    }
694                  },
695                  "collection_id": {
696                    "type": "array",
697                    "description": "List of collection id available for offer",
698                    "items": {
699                      "type": "string"
700                    }
701                  },
702                  "all_items": {
703                    "description": "Boolean flag determining if offer is applicable on all offers",
704                    "type": "boolean"
705                  },
706                  "item_brand": {
707                    "type": "array",
708                    "description": "List of all brand ids on which promotion is applicable",
709                    "items": {
710                      "type": "integer",
711                      "format": "int32"
712                    }
713                  },
714                  "article_ids": {
715                    "type": "array",
716                    "description": "List of unique identifier of articles on which offer will be applicable",
717                    "items": {
718                      "type": "string"
719                    }
720                  },
721                  "item_sku": {
722                    "type": "array",
723                    "description": "List of all item sku on which promotion is applicable",
724                    "items": {
725                      "type": "string"
726                    }
727                  },
728                  "item_id": {
729                    "type": "array",
730                    "description": "List of all item ids on which offer is applicable",
731                    "items": {
732                      "type": "integer",
733                      "format": "int32"
734                    }
735                  },
736                  "item_l1_category": {
737                    "type": "array",
738                    "description": "List of all L1 category on which offer is applicable",
739                    "items": {
740                      "type": "integer",
741                      "format": "int32",
742                      "x-not-enum": true
743                    }
744                  },
745                  "item_l2_category": {
746                    "type": "array",
747                    "description": "List of all L2 category on which offer is applicable",
748                    "items": {
749                      "type": "integer",
750                      "format": "int32",
751                      "x-not-enum": true
752                    }
753                  },
754                  "item_category": {
755                    "type": "array",
756                    "description": "List of all L3 category on which offer is applicable",
757                    "items": {
758                      "type": "integer",
759                      "format": "int32",
760                      "x-not-enum": true
761                    }
762                  },
763                  "item_department": {
764                    "type": "array",
765                    "description": "List of all departments ids on which offer is applicable",
766                    "items": {
767                      "type": "integer",
768                      "format": "int32"
769                    }
770                  },
771                  "item_store": {
772                    "type": "array",
773                    "description": "List of all item store ids on which offer is applicable",
774                    "items": {
775                      "type": "integer",
776                      "format": "int32"
777                    }
778                  },
779                  "item_size": {
780                    "type": "array",
781                    "description": "List of all item sizes on which offer is applicable",
782                    "items": {
783                      "type": "string"
784                    }
785                  },
786                  "item_company": {
787                    "type": "array",
788                    "description": "List of all company ids on which offer is applicable",
789                    "items": {
790                      "type": "integer",
791                      "format": "int32"
792                    }
793                  },
794                  "item_tags": {
795                    "type": "array",
796                    "description": "List of all product tags on which offer is applicable",
797                    "items": {
798                      "type": "string"
799                    }
800                  },
801                  "cart_quantity": {
802                    "type": "object",
803                    "description": "Manage operator and their value for cart rules in promotion",
804                    "properties": {
805                      "equals": {
806                        "type": [
807                          "number",
808                          null
809                        ],
810                        "format": "float",
811                        "nullable": true,
812                        "description": "Nummeric value must be equal to cart level rules"
813                      },
814                      "greater_than": {
815                        "type": [
816                          "number",
817                          null
818                        ],
819                        "format": "float",
820                        "nullable": true,
821                        "description": "Nummeric value must be greater than cart level rules"
822                      },
823                      "less_than_equals": {
824                        "type": [
825                          "number",
826                          null
827                        ],
828                        "format": "float",
829                        "nullable": true,
830                        "description": "Nummeric value must be less than or equal to cart level rules"
831                      },
832                      "less_than": {
833                        "type": [
834                          "number",
835                          null
836                        ],
837                        "format": "float",
838                        "nullable": true,
839                        "description": "Nummeric value must be less than cart level rules"
840                      },
841                      "greater_than_equals": {
842                        "type": [
843                          "number",
844                          null
845                        ],
846                        "format": "float",
847                        "nullable": true,
848                        "description": "Nummeric value must be greater than or equal to cart level rules"
849                      }
850                    }
851                  },
852                  "cart_total": {
853                    "type": "object",
854                    "description": "Manage operator and their value for cart rules in promotion",
855                    "properties": {
856                      "equals": {
857                        "type": [
858                          "number",
859                          null
860                        ],
861                        "format": "float",
862                        "nullable": true,
863                        "description": "Nummeric value must be equal to cart level rules"
864                      },
865                      "greater_than": {
866                        "type": [
867                          "number",
868                          null
869                        ],
870                        "format": "float",
871                        "nullable": true,
872                        "description": "Nummeric value must be greater than cart level rules"
873                      },
874                      "less_than_equals": {
875                        "type": [
876                          "number",
877                          null
878                        ],
879                        "format": "float",
880                        "nullable": true,
881                        "description": "Nummeric value must be less than or equal to cart level rules"
882                      },
883                      "less_than": {
884                        "type": [
885                          "number",
886                          null
887                        ],
888                        "format": "float",
889                        "nullable": true,
890                        "description": "Nummeric value must be less than cart level rules"
891                      },
892                      "greater_than_equals": {
893                        "type": [
894                          "number",
895                          null
896                        ],
897                        "format": "float",
898                        "nullable": true,
899                        "description": "Nummeric value must be greater than or equal to cart level rules"
900                      }
901                    }
902                  },
903                  "item_exclude_l1_category": {
904                    "type": "array",
905                    "description": "List of all L1 categories on which offer is not applicable",
906                    "items": {
907                      "type": "integer",
908                      "format": "int32",
909                      "x-not-enum": true
910                    }
911                  },
912                  "item_exclude_l2_category": {
913                    "type": "array",
914                    "description": "List of all L2 categories on which offer is not applicable",
915                    "items": {
916                      "type": "integer",
917                      "format": "int32",
918                      "x-not-enum": true
919                    }
920                  },
921                  "item_exclude_category": {
922                    "type": "array",
923                    "description": "List of all L3 categories on which offer is not applicable",
924                    "items": {
925                      "type": "integer",
926                      "format": "int32",
927                      "x-not-enum": true
928                    }
929                  },
930                  "cart_unique_item_quantity": {
931                    "type": "object",
932                    "description": "Manage operator and their value for cart rules in promotion",
933                    "properties": {
934                      "equals": {
935                        "type": [
936                          "number",
937                          null
938                        ],
939                        "format": "float",
940                        "nullable": true,
941                        "description": "Nummeric value must be equal to cart level rules"
942                      },
943                      "greater_than": {
944                        "type": [
945                          "number",
946                          null
947                        ],
948                        "format": "float",
949                        "nullable": true,
950                        "description": "Nummeric value must be greater than cart level rules"
951                      },
952                      "less_than_equals": {
953                        "type": [
954                          "number",
955                          null
956                        ],
957                        "format": "float",
958                        "nullable": true,
959                        "description": "Nummeric value must be less than or equal to cart level rules"
960                      },
961                      "less_than": {
962                        "type": [
963                          "number",
964                          null
965                        ],
966                        "format": "float",
967                        "nullable": true,
968                        "description": "Nummeric value must be less than cart level rules"
969                      },
970                      "greater_than_equals": {
971                        "type": [
972                          "number",
973                          null
974                        ],
975                        "format": "float",
976                        "nullable": true,
977                        "description": "Nummeric value must be greater than or equal to cart level rules"
978                      }
979                    }
980                  },
981                  "cart_unique_item_amount": {
982                    "type": "object",
983                    "description": "Manage operator and their value for cart rules in promotion",
984                    "properties": {
985                      "equals": {
986                        "type": [
987                          "number",
988                          null
989                        ],
990                        "format": "float",
991                        "nullable": true,
992                        "description": "Nummeric value must be equal to cart level rules"
993                      },
994                      "greater_than": {
995                        "type": [
996                          "number",
997                          null
998                        ],
999                        "format": "float",
1000                        "nullable": true,
1001                        "description": "Nummeric value must be greater than cart level rules"
1002                      },
1003                      "less_than_equals": {
1004                        "type": [
1005                          "number",
1006                          null
1007                        ],
1008                        "format": "float",
1009                        "nullable": true,
1010                        "description": "Nummeric value must be less than or equal to cart level rules"
1011                      },
1012                      "less_than": {
1013                        "type": [
1014                          "number",
1015                          null
1016                        ],
1017                        "format": "float",
1018                        "nullable": true,
1019                        "description": "Nummeric value must be less than cart level rules"
1020                      },
1021                      "greater_than_equals": {
1022                        "type": [
1023                          "number",
1024                          null
1025                        ],
1026                        "format": "float",
1027                        "nullable": true,
1028                        "description": "Nummeric value must be greater than or equal to cart level rules"
1029                      }
1030                    }
1031                  },
1032                  "item_exclude_department": {
1033                    "type": "array",
1034                    "description": "List of all department ids on which offer is not applicable",
1035                    "items": {
1036                      "type": "integer",
1037                      "format": "int32"
1038                    }
1039                  },
1040                  "item_exclude_store": {
1041                    "type": "array",
1042                    "description": "List of all item store ids on which offer is not applicable",
1043                    "items": {
1044                      "type": "integer",
1045                      "format": "int32"
1046                    }
1047                  },
1048                  "item_exclude_brand": {
1049                    "type": "array",
1050                    "description": "List of all brand ids on which offer is not applicable",
1051                    "items": {
1052                      "type": "integer",
1053                      "format": "int32"
1054                    }
1055                  },
1056                  "item_exclude_sku": {
1057                    "type": "array",
1058                    "description": "List of all item sku on which offer is not applicable",
1059                    "items": {
1060                      "type": "string"
1061                    }
1062                  },
1063                  "item_exclude_company": {
1064                    "type": "array",
1065                    "description": "List of all company id on which offer is not applicable",
1066                    "items": {
1067                      "type": "integer",
1068                      "format": "int32"
1069                    }
1070                  },
1071                  "available_zones": {
1072                    "type": "array",
1073                    "description": "List of all zones on which offer is applicable",
1074                    "items": {
1075                      "type": "string"
1076                    }
1077                  },
1078                  "item_exclude_id": {
1079                    "type": "array",
1080                    "description": "List of all item ids on which offer is not applicable",
1081                    "items": {
1082                      "type": "integer",
1083                      "format": "int32"
1084                    }
1085                  },
1086                  "buy_rules": {
1087                    "type": "array",
1088                    "description": "List of buy rules that is applicable for this offer",
1089                    "items": {
1090                      "type": "string"
1091                    }
1092                  },
1093                  "item_size_mapping": {
1094                    "type": "object",
1095                    "description": "Map size with product in promotion",
1096                    "properties": {
1097                      "item_size_mapping": {
1098                        "type": "object",
1099                        "description": "Item size mapping in promotion",
1100                        "additionalProperties": true
1101                      }
1102                    }
1103                  }
1104                }
1105              }
1106            },
1107            "restrictions": {
1108              "type": "object",
1109              "description": "Restrictions for offers to be applied",
1110              "properties": {
1111                "uses": {
1112                  "type": "object",
1113                  "description": "Usage restrictions",
1114                  "properties": {
1115                    "maximum": {
1116                      "type": "object",
1117                      "description": "Determines the maximum usage count of offer.",
1118                      "properties": {
1119                        "user": {
1120                          "type": "integer",
1121                          "default": 0,
1122                          "description": "Determines the maximum usage count of offer per user.",
1123                          "format": "int32"
1124                        },
1125                        "total": {
1126                          "type": "integer",
1127                          "default": 0,
1128                          "description": "Determines the overall offer usage count.",
1129                          "format": "int32"
1130                        },
1131                        "app": {
1132                          "type": "integer",
1133                          "default": 0,
1134                          "description": "Determines the offer usage count associated with application id.",
1135                          "format": "int32"
1136                        }
1137                      }
1138                    },
1139                    "remaining": {
1140                      "type": "object",
1141                      "description": "Determines the remaining usage count of offer",
1142                      "properties": {
1143                        "user": {
1144                          "type": "integer",
1145                          "default": 0,
1146                          "description": "Determines the remaining usage count of offer per user.",
1147                          "format": "int32"
1148                        },
1149                        "total": {
1150                          "type": "integer",
1151                          "default": 0,
1152                          "description": "Determines the overall remaining offer usage count.",
1153                          "format": "int32"
1154                        },
1155                        "app": {
1156                          "type": "integer",
1157                          "default": 0,
1158                          "description": "Determines the remaining offer usage count associated with application id.",
1159                          "format": "int32"
1160                        }
1161                      }
1162                    }
1163                  }
1164                },
1165                "post_order": {
1166                  "type": "object",
1167                  "description": "Post order restrictions",
1168                  "properties": {
1169                    "return_allowed": {
1170                      "type": "boolean",
1171                      "description": "Allow returns"
1172                    },
1173                    "cancellation_allowed": {
1174                      "type": "boolean",
1175                      "description": "Allow cancellations"
1176                    }
1177                  }
1178                },
1179                "platforms": {
1180                  "type": "array",
1181                  "default": [
1182                    "web",
1183                    "android",
1184                    "ios"
1185                  ],
1186                  "description": "List of platform on which offer allowed like web, android",
1187                  "items": {
1188                    "type": "string"
1189                  }
1190                },
1191                "user": {
1192                  "type": "object",
1193                  "description": "Filter offer user criteria",
1194                  "properties": {
1195                    "groups": {
1196                      "type": "array",
1197                      "description": "List of user group on which offer is allowed",
1198                      "items": {
1199                        "type": "integer",
1200                        "format": "int32"
1201                      }
1202                    },
1203                    "exclude_groups": {
1204                      "type": "array",
1205                      "description": "List of user groups on which offer is not allowed",
1206                      "items": {
1207                        "type": "integer",
1208                        "format": "int32"
1209                      }
1210                    },
1211                    "type": {
1212                      "type": "string",
1213                      "description": "User type of the cart user who places the order",
1214                      "enum": [
1215                        "all_user",
1216                        "guest",
1217                        "registered",
1218                        "user_group"
1219                      ]
1220                    },
1221                    "anonymous": {
1222                      "type": "boolean",
1223                      "description": "Set true, if offer is applicable for guest user"
1224                    },
1225                    "id": {
1226                      "type": "array",
1227                      "description": "List of user id on which offer is applicable",
1228                      "items": {
1229                        "type": "string"
1230                      }
1231                    },
1232                    "email_domain": {
1233                      "type": "array",
1234                      "description": "List of email domain available for offer",
1235                      "items": {
1236                        "type": "string"
1237                      }
1238                    }
1239                  }
1240                },
1241                "multi_store_allowed": {
1242                  "type": "boolean",
1243                  "default": false,
1244                  "description": "Allow offer to be applied on multiple stores"
1245                },
1246                "fulfillment_options": {
1247                  "type": "array",
1248                  "description": "List of fulfillment options on which offer is applicable.",
1249                  "items": {
1250                    "type": "object",
1251                    "properties": {
1252                      "fulfillment_slug": {
1253                        "type": "string",
1254                        "description": "Fulfillment option id"
1255                      },
1256                      "zones": {
1257                        "type": "array",
1258                        "description": "List of zones ids on which offer is applicable.",
1259                        "items": {
1260                          "type": "string"
1261                        }
1262                      }
1263                    }
1264                  }
1265                }
1266              }
1267            },
1268            "display_meta": {
1269              "type": "object",
1270              "description": "Display meta information regarding the offer",
1271              "properties": {
1272                "description": {
1273                  "description": "Detail about the offers",
1274                  "type": [
1275                    "string",
1276                    null
1277                  ],
1278                  "nullable": true
1279                },
1280                "is_display": {
1281                  "type": "boolean",
1282                  "default": true,
1283                  "description": "Coupon offer will be displayed or hidden on UI based on this flag"
1284                },
1285                "is_public": {
1286                  "type": "boolean",
1287                  "default": true,
1288                  "description": "Determines if coupon offer is publicaly available or not"
1289                },
1290                "name": {
1291                  "type": [
1292                    "string",
1293                    null
1294                  ],
1295                  "nullable": true,
1296                  "description": "Name of offer that needs to display"
1297                },
1298                "offer_text": {
1299                  "type": [
1300                    "string",
1301                    null
1302                  ],
1303                  "nullable": true,
1304                  "description": "Promotion offer text used to display"
1305                },
1306                "offer_label": {
1307                  "type": [
1308                    "string",
1309                    null
1310                  ],
1311                  "description": "Offer label of promotion that needs to display",
1312                  "nullable": true
1313                },
1314                "reason": {
1315                  "type": [
1316                    "string",
1317                    null
1318                  ],
1319                  "nullable": true,
1320                  "description": "Reason for offer rejection"
1321                }
1322              }
1323            },
1324            "ownership": {
1325              "type": "object",
1326              "description": "Ownership details of the offer",
1327              "properties": {
1328                "payable_category": {
1329                  "type": "string",
1330                  "description": "Promotion amount payable category",
1331                  "enum": [
1332                    "fynd",
1333                    "seller",
1334                    "marketplace"
1335                  ]
1336                },
1337                "payable_by": {
1338                  "type": [
1339                    "string",
1340                    null
1341                  ],
1342                  "description": "Promotion amount bearable party",
1343                  "enum": [
1344                    "fynd",
1345                    "seller",
1346                    "marketplace",
1347                    null
1348                  ],
1349                  "nullable": true
1350                }
1351              }
1352            },
1353            "author": {
1354              "type": "object",
1355              "description": "Author information of the offer",
1356              "properties": {
1357                "modified_by": {
1358                  "type": "string",
1359                  "description": "User who last modified the offer"
1360                },
1361                "rejected_by": {
1362                  "type": [
1363                    "string",
1364                    null
1365                  ],
1366                  "nullable": true,
1367                  "description": "User who rejected the offer"
1368                },
1369                "approved_by": {
1370                  "type": [
1371                    "string",
1372                    null
1373                  ],
1374                  "nullable": true,
1375                  "description": "User who approved the offer"
1376                },
1377                "created_by": {
1378                  "type": "string",
1379                  "description": "User who created the offer"
1380                }
1381              }
1382            },
1383            "date_meta": {
1384              "type": "object",
1385              "description": "Date metadata of the offer",
1386              "properties": {
1387                "rejected_on": {
1388                  "type": [
1389                    "string",
1390                    null
1391                  ],
1392                  "format": "date-time",
1393                  "nullable": true,
1394                  "description": "Date when offer was rejected"
1395                },
1396                "created_on": {
1397                  "type": "string",
1398                  "format": "date-time",
1399                  "description": "Date when offer was created"
1400                },
1401                "approved_on": {
1402                  "type": [
1403                    "string",
1404                    null
1405                  ],
1406                  "format": "date-time",
1407                  "nullable": true,
1408                  "description": "Date when offer was approved"
1409                },
1410                "modified_on": {
1411                  "type": "string",
1412                  "format": "date-time",
1413                  "description": "Date when offer was last modified"
1414                }
1415              }
1416            },
1417            "_schedule": {
1418              "type": "object",
1419              "description": "Schedule information of the offer",
1420              "properties": {
1421                "cron": {
1422                  "type": [
1423                    "string",
1424                    null
1425                  ],
1426                  "description": "Cron expression for scheduling"
1427                },
1428                "start": {
1429                  "type": "string",
1430                  "format": "date-time",
1431                  "description": "Start date of the offer"
1432                },
1433                "end": {
1434                  "type": "string",
1435                  "format": "date-time",
1436                  "description": "End date of the offer"
1437                },
1438                "duration": {
1439                  "type": [
1440                    "integer",
1441                    null
1442                  ],
1443                  "format": "int32",
1444                  "description": "Duration of the offer in seconds"
1445                }
1446              }
1447            },
1448            "_custom_json": {
1449              "type": "object",
1450              "description": "Set extra properties in offer",
1451              "additionalProperties": true
1452            },
1453            "stackable": {
1454              "type": "boolean",
1455              "default": true,
1456              "description": "Boolean value set true to apply other promotions as well."
1457            },
1458            "type": {
1459              "type": "string",
1460              "description": "Specifies the type of offer in the system, which determines how the discount is calculated. Some types are mode-specific, for example, free_item_discount_absolute is only applicable for coupon mode and contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount are only applicable for promotion mode.",
1461              "enum": [
1462                "percentage",
1463                "amount",
1464                "bundle_price_percentage",
1465                "bundle_price_amount",
1466                "bundle_amount_percentage",
1467                "bogo",
1468                "fixed_price",
1469                "shipping_price",
1470                "free_gift_items",
1471                "free_item_discount_absolute",
1472                "bundle_discount_quantity_percentage",
1473                "item_based_discount",
1474                "ladder_price",
1475                "contract_price",
1476                "custom"
1477              ]
1478            },
1479            "priority": {
1480              "type": "integer",
1481              "format": "int32",
1482              "maximum": 100000,
1483              "default": 1,
1484              "description": "Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied.\n"
1485            },
1486            "is_exclusive_coupon": {
1487              "type": "boolean",
1488              "default": false,
1489              "description": "Flag to determine if coupon is exclusive"
1490            },
1491            "apply_exclusive": {
1492              "type": [
1493                "string",
1494                null
1495              ],
1496              "description": "Offer should apply on either article or cart.",
1497              "default": "cart",
1498              "enum": [
1499                "cart",
1500                "article",
1501                null
1502              ],
1503              "nullable": true
1504            },
1505            "apply_all_discount": {
1506              "type": "boolean",
1507              "default": false,
1508              "description": "Apply all discount offers if true"
1509            },
1510            "calculate_on": {
1511              "type": "string",
1512              "description": "Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.",
1513              "default": "esp",
1514              "enum": [
1515                "mrp",
1516                "esp"
1517              ]
1518            },
1519            "promo_group": {
1520              "type": "string",
1521              "description": "The type of promotion group",
1522              "default": "product",
1523              "enum": [
1524                "cart",
1525                "product",
1526                "contract",
1527                "ladder_price",
1528                "limited_timer"
1529              ]
1530            },
1531            "currency": {
1532              "description": "Offer Currency code like INR",
1533              "type": "string"
1534            },
1535            "code": {
1536              "description": "Offer unique code",
1537              "type": "string"
1538            },
1539            "is_processed": {
1540              "type": "boolean",
1541              "description": "Flag to verify if promotion is ready to be applied on cart and ready to update promotion"
1542            },
1543            "is_bank_offer": {
1544              "type": "boolean",
1545              "default": false,
1546              "description": "Flag to determine if any bank offer is applicable"
1547            },
1548            "filter_tags": {
1549              "type": "array",
1550              "default": [],
1551              "description": "Tags used to filter offers in list APIs",
1552              "items": {
1553                "type": "string"
1554              }
1555            },
1556            "_source": {
1557              "type": "object",
1558              "description": "Source of the offer",
1559              "properties": {
1560                "type": {
1561                  "type": "string",
1562                  "description": "Type of the source i.e extension"
1563                },
1564                "id": {
1565                  "type": "string",
1566                  "description": "ID of the source i.e extension id"
1567                }
1568              }
1569            }
1570          }
1571        }
1572      }
1573    }
1574  }
1575}