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.

Order

This event will be generated where there is any action done on order

Events

application/order/placed/v1

# This event is triggered when order is placed

application/order/pending/v1

# This event is triggered when order is pending

application/order/payment_failed/v1

# This event is triggered when order is payment_failed

Order/order/placed/v1

This event is triggered when order is placed

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

meta

object

Properties

order_platform

string|null

ordering_store_details

object

Details of the store from which the order was placed.For example, in StoreOS, this represents the ordering store's information.

Properties

number

Unique identifier for the store.

code

string

Alphanumeric code representing the store.

name

string

Name of the store.

address

string

Physical address of the store.

state

string

State where the store is located.

city

string

City where the store is located.

pincode

string

Postal code (pincode) of the store's location.

country

string

Country where the store is situated.

phone

string

Contact phone number for the store.

fulfillment_channel

string

Type of fulfillment channel used by the store.

location_type

string

Type of location e.g., warehouse, high_street

Enum

company_id

number

Identifier of the company responsible for fulfilling shipments from this store

is_active

boolean

Boolean indicating whether the store is currently active

meta

object

Meta data related to bag item

Properties

group_id

string|null

Group ID of the bag, used in case of promotion/bundle products to group the bags

gift_card

object

docket_number

string|null

Unique Identifier for the bags per shipment

partial_can_ret

boolean

Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)

store

object

Fulfilling store information related of the shipment

Properties

name

string|null

Name of the store

discount

number|null

Discount received on the individual bag

quantity

integer|null

Quantity of the bag

article_json

object

Article's attribute information, contains attributes information of the article

Properties

identifier

object

Product Identifier details, contains ean/sku

Properties

ean

string|null

affiliate_meta

object

Sales channel meta data information for the bag

Properties

fynd

object

Properties

fulfilment_identifier

string|null

fulfilment_identifiers_list

array|object

box_type

null

coupon_code

string|null

is_priority

boolean

loyalty_discount

number|null

employee_discount

integer|null

size_level_total_qty

integer|null

brand_calculated_amount

number

Effective selling price - Brand's additional discounts

meta

object

Shipment meta data information

Properties

dp_id

string|null

Delivery Partner id that is going to process the shipment

weight

number|null

Weight of the shipment

external

object|null

formatted

object

formatted max and min expected delivery date

Properties

max

string|null

max expected delivery date

min

string|null

min expected delivery date

lock_data

object

Shipment lock information.

Properties

mto

boolean

Made to Order shipment (seller will start production after order placement)

locked

boolean

If shipment is locked or not.

lock_message

string|null

Shipment Lock message, contains reason for locking shipment

timestamp

object

timestamp of expected delivery date

bag_weight

object

debug_info

object

dp_options

object

All available delivery partner options for the the shipment

order_type

string|null

Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example: - "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address. - "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person. - "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.

dp_sort_key

string|null

parent_dp_id

string|null

shipping_zone

string|null

packaging_name

string|null

shipment_weight

integer

Total weight of the shipment in Grams

assign_dp_from_sb

boolean

same_store_available

boolean

Is Ordering and Fulfilling store are same for the shipemnt

fulfilment_priority_text

string|null

shipment_chargeable_weight

number

Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater

shipment_volumetric_weight

number|null

Dimensional weight of the shipment, calculated using length, width and height of a package.

auto_trigger_dp_assignment_ACF

boolean

Will Delivery Partner Auto Assigned or not From Stormbreaker

billing_address_json

object

Address by which the invoice is created

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

delivery_address_json

object

Delivery address information

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

coupon_json

object

Applied coupon information

order_value

number|null

Value of the order

affiliate_id

string|null

Sales channel ID

coupon_value

number

Value of the discount being applied by the coupon

payment_mode

object

Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.

Properties

mode

string|null

fynd_order_id

string|null

Unique identifier of the order which is defined by Fynd

app_company_id

integer

Company id of the sales channel

ordering_store

object

Information of the store from which order is initially placed

Properties

code

string|null

delivery_charges

number

The amount charged for delivery apart from the product price

ordering_channel

string|null

The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.

ordering_source

string

Nullable

To uniquely identify the source through which order has been placed.

loyalty_discount_details

object

Applied loyalty discount information

Properties

discount

number

Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed

ownership

string

Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace

is_applied

boolean

Specifies whether the loyalty discount has been applied to the order

loyalty_discount

number

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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "properties": {
83            "meta": {
84              "type": "object",
85              "properties": {
86                "order_platform": {
87                  "type": [
88                    "string",
89                    "null"
90                  ]
91                }
92              }
93            },
94            "ordering_store_details": {
95              "description": "Details of the store from which the order was placed.For example, in StoreOS, this represents the ordering store's information.",
96              "type": "object",
97              "properties": {
98                "id": {
99                  "type": "number",
100                  "description": "Unique identifier for the store."
101                },
102                "code": {
103                  "type": "string",
104                  "description": "Alphanumeric code representing the store."
105                },
106                "name": {
107                  "type": "string",
108                  "description": "Name of the store."
109                },
110                "address": {
111                  "type": "string",
112                  "description": "Physical address of the store."
113                },
114                "state": {
115                  "type": "string",
116                  "description": "State where the store is located."
117                },
118                "city": {
119                  "type": "string",
120                  "description": "City where the store is located."
121                },
122                "pincode": {
123                  "type": "string",
124                  "description": "Postal code (pincode) of the store's location."
125                },
126                "country": {
127                  "type": "string",
128                  "description": "Country where the store is situated."
129                },
130                "phone": {
131                  "type": "string",
132                  "description": "Contact phone number for the store."
133                },
134                "fulfillment_channel": {
135                  "type": "string",
136                  "description": "Type of fulfillment channel used by the store."
137                },
138                "location_type": {
139                  "type": "string",
140                  "enum": [
141                    "high_street",
142                    "mall",
143                    "store",
144                    "warehouse"
145                  ],
146                  "description": "Type of location e.g., warehouse, high_street"
147                },
148                "company_id": {
149                  "type": "number",
150                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
151                },
152                "is_active": {
153                  "type": "boolean",
154                  "description": "Boolean indicating whether the store is currently active"
155                },
156                "tags": {
157                  "type": "array",
158                  "items": {
159                    "type": "string"
160                  },
161                  "description": "Array of tags associated with the store"
162                }
163              },
164              "required": []
165            },
166            "user": {
167              "type": [
168                "object",
169                "null"
170              ],
171              "properties": {
172                "mobile": {
173                  "type": "string"
174                },
175                "last_name": {
176                  "type": [
177                    "string",
178                    "null"
179                  ]
180                },
181                "first_name": {
182                  "type": [
183                    "string",
184                    "null"
185                  ]
186                }
187              },
188              "description": "Purchaser's Details such as name, last name, mobile no. and email"
189            },
190            "status": {
191              "type": [
192                "string",
193                "null"
194              ],
195              "description": "State of the order, e.g. placed, confirmed, cancelled"
196            },
197            "discount": {
198              "type": "number",
199              "description": "Discount received on the shipment"
200            },
201            "shipments": {
202              "type": "array",
203              "items": {
204                "type": "object",
205                "properties": {
206                  "id": {
207                    "type": [
208                      "string",
209                      "null"
210                    ]
211                  },
212                  "bags": {
213                    "type": "array",
214                    "description": "Details of all the products/articles in a shipment",
215                    "items": {
216                      "type": "object",
217                      "properties": {
218                        "item": {
219                          "type": "object",
220                          "properties": {
221                            "name": {
222                              "type": [
223                                "string",
224                                "null"
225                              ],
226                              "description": "The name of the item being referenced"
227                            }
228                          }
229                        },
230                        "meta": {
231                          "type": "object",
232                          "properties": {
233                            "group_id": {
234                              "type": [
235                                "string",
236                                "null"
237                              ],
238                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
239                            },
240                            "gift_card": {
241                              "type": "object"
242                            },
243                            "docket_number": {
244                              "type": [
245                                "string",
246                                "null"
247                              ],
248                              "description": "Unique Identifier for the bags per shipment"
249                            },
250                            "partial_can_ret": {
251                              "type": "boolean",
252                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
253                            }
254                          },
255                          "description": "Meta data related to bag item"
256                        },
257                        "store": {
258                          "type": "object",
259                          "properties": {
260                            "name": {
261                              "type": [
262                                "string",
263                                "null"
264                              ],
265                              "description": "Name of the store"
266                            }
267                          },
268                          "description": "Fulfilling store information related of the shipment"
269                        },
270                        "discount": {
271                          "type": [
272                            "number",
273                            "null"
274                          ],
275                          "description": "Discount received on the individual bag"
276                        },
277                        "quantity": {
278                          "type": [
279                            "integer",
280                            "null"
281                          ],
282                          "description": "Quantity of the bag"
283                        },
284                        "article_json": {
285                          "type": "object",
286                          "properties": {
287                            "identifier": {
288                              "type": "object",
289                              "properties": {
290                                "ean": {
291                                  "type": [
292                                    "string",
293                                    "null"
294                                  ]
295                                }
296                              },
297                              "description": "Product Identifier details, contains ean/sku"
298                            }
299                          },
300                          "description": "Article's attribute information, contains attributes information of the article"
301                        },
302                        "affiliate_meta": {
303                          "type": "object",
304                          "properties": {
305                            "fynd": {
306                              "type": "object",
307                              "properties": {
308                                "fulfilment_identifier": {
309                                  "type": [
310                                    "string",
311                                    "null"
312                                  ]
313                                },
314                                "fulfilment_identifiers_list": {
315                                  "type": [
316                                    "array",
317                                    "object"
318                                  ]
319                                }
320                              }
321                            },
322                            "box_type": {
323                              "type": "null"
324                            },
325                            "coupon_code": {
326                              "type": [
327                                "string",
328                                "null"
329                              ]
330                            },
331                            "is_priority": {
332                              "type": "boolean"
333                            },
334                            "loyalty_discount": {
335                              "type": [
336                                "number",
337                                "null"
338                              ]
339                            },
340                            "employee_discount": {
341                              "type": [
342                                "integer",
343                                "null"
344                              ]
345                            },
346                            "size_level_total_qty": {
347                              "type": [
348                                "integer",
349                                "null"
350                              ]
351                            }
352                          },
353                          "description": "Sales channel meta data information for the bag"
354                        },
355                        "brand_calculated_amount": {
356                          "type": "number",
357                          "description": "Effective selling price  - Brand's additional discounts"
358                        }
359                      }
360                    }
361                  },
362                  "meta": {
363                    "type": "object",
364                    "properties": {
365                      "dp_id": {
366                        "type": [
367                          "string",
368                          "null"
369                        ],
370                        "description": "Delivery Partner id that is going to process the shipment"
371                      },
372                      "weight": {
373                        "type": [
374                          "number",
375                          "null"
376                        ],
377                        "description": "Weight of the shipment"
378                      },
379                      "external": {
380                        "type": [
381                          "object",
382                          "null"
383                        ]
384                      },
385                      "formatted": {
386                        "type": "object",
387                        "properties": {
388                          "max": {
389                            "type": [
390                              "string",
391                              "null"
392                            ],
393                            "description": "max expected delivery date"
394                          },
395                          "min": {
396                            "type": [
397                              "string",
398                              "null"
399                            ],
400                            "description": "min expected delivery date"
401                          }
402                        },
403                        "description": "formatted max and min expected delivery date"
404                      },
405                      "lock_data": {
406                        "type": "object",
407                        "properties": {
408                          "mto": {
409                            "type": "boolean",
410                            "description": "Made to Order shipment (seller will start production after order placement)"
411                          },
412                          "locked": {
413                            "type": "boolean",
414                            "description": "If shipment is locked or not."
415                          },
416                          "lock_message": {
417                            "type": [
418                              "string",
419                              "null"
420                            ],
421                            "description": "Shipment Lock message, contains reason for locking shipment"
422                          }
423                        },
424                        "description": "Shipment lock information."
425                      },
426                      "timestamp": {
427                        "type": "object",
428                        "description": "timestamp of expected delivery date"
429                      },
430                      "bag_weight": {
431                        "type": "object"
432                      },
433                      "debug_info": {
434                        "type": "object"
435                      },
436                      "dp_options": {
437                        "type": "object",
438                        "description": "All available delivery partner options for the the shipment"
439                      },
440                      "order_type": {
441                        "type": [
442                          "string",
443                          "null"
444                        ],
445                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically. \n"
446                      },
447                      "dp_sort_key": {
448                        "type": [
449                          "string",
450                          "null"
451                        ]
452                      },
453                      "parent_dp_id": {
454                        "type": [
455                          "string",
456                          "null"
457                        ]
458                      },
459                      "shipping_zone": {
460                        "type": [
461                          "string",
462                          "null"
463                        ]
464                      },
465                      "packaging_name": {
466                        "type": [
467                          "string",
468                          "null"
469                        ]
470                      },
471                      "shipment_weight": {
472                        "type": "integer",
473                        "description": "Total weight of the shipment in Grams"
474                      },
475                      "assign_dp_from_sb": {
476                        "type": "boolean"
477                      },
478                      "same_store_available": {
479                        "type": "boolean",
480                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
481                      },
482                      "fulfilment_priority_text": {
483                        "type": [
484                          "string",
485                          "null"
486                        ]
487                      },
488                      "shipment_chargeable_weight": {
489                        "type": "number",
490                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
491                      },
492                      "shipment_volumetric_weight": {
493                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
494                        "type": [
495                          "number",
496                          "null"
497                        ]
498                      },
499                      "auto_trigger_dp_assignment_ACF": {
500                        "type": "boolean",
501                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
502                      }
503                    },
504                    "description": "Shipment meta data information"
505                  },
506                  "billing_address_json": {
507                    "type": "object",
508                    "properties": {
509                      "area": {
510                        "type": [
511                          "string",
512                          "null"
513                        ]
514                      },
515                      "city": {
516                        "type": [
517                          "string",
518                          "null"
519                        ]
520                      },
521                      "name": {
522                        "type": [
523                          "string",
524                          "null"
525                        ]
526                      },
527                      "email": {
528                        "type": [
529                          "string",
530                          "null"
531                        ]
532                      },
533                      "phone": {
534                        "type": [
535                          "string",
536                          "null"
537                        ]
538                      },
539                      "state": {
540                        "type": [
541                          "string",
542                          "null"
543                        ]
544                      },
545                      "address": {
546                        "type": [
547                          "string",
548                          "null"
549                        ]
550                      },
551                      "country": {
552                        "type": [
553                          "string",
554                          "null"
555                        ]
556                      },
557                      "pincode": {
558                        "type": [
559                          "string",
560                          "null"
561                        ]
562                      },
563                      "version": {
564                        "type": [
565                          "string",
566                          "null"
567                        ]
568                      },
569                      "address1": {
570                        "type": [
571                          "string",
572                          "null"
573                        ]
574                      },
575                      "address2": {
576                        "type": [
577                          "string",
578                          "null"
579                        ]
580                      },
581                      "landmark": {
582                        "type": [
583                          "string",
584                          "null"
585                        ]
586                      },
587                      "latitude": {
588                        "type": "number"
589                      },
590                      "area_code": {
591                        "type": [
592                          "string",
593                          "null"
594                        ]
595                      },
596                      "longitude": {
597                        "type": "number"
598                      },
599                      "created_at": {
600                        "type": [
601                          "string",
602                          "null"
603                        ]
604                      },
605                      "updated_at": {
606                        "type": [
607                          "string",
608                          "null"
609                        ]
610                      },
611                      "address_type": {
612                        "type": [
613                          "string",
614                          "null"
615                        ]
616                      },
617                      "contact_person": {
618                        "type": [
619                          "string",
620                          "null"
621                        ]
622                      },
623                      "address_category": {
624                        "type": [
625                          "string",
626                          "null"
627                        ]
628                      }
629                    },
630                    "description": "Address by which the invoice is created"
631                  },
632                  "delivery_address_json": {
633                    "type": "object",
634                    "properties": {
635                      "area": {
636                        "type": [
637                          "string",
638                          "null"
639                        ]
640                      },
641                      "city": {
642                        "type": [
643                          "string",
644                          "null"
645                        ]
646                      },
647                      "name": {
648                        "type": [
649                          "string",
650                          "null"
651                        ]
652                      },
653                      "email": {
654                        "type": [
655                          "string",
656                          "null"
657                        ]
658                      },
659                      "phone": {
660                        "type": [
661                          "string",
662                          "null"
663                        ]
664                      },
665                      "state": {
666                        "type": [
667                          "string",
668                          "null"
669                        ]
670                      },
671                      "address": {
672                        "type": [
673                          "string",
674                          "null"
675                        ]
676                      },
677                      "country": {
678                        "type": [
679                          "string",
680                          "null"
681                        ]
682                      },
683                      "pincode": {
684                        "type": [
685                          "string",
686                          "null"
687                        ]
688                      },
689                      "version": {
690                        "type": [
691                          "string",
692                          "null"
693                        ]
694                      },
695                      "address1": {
696                        "type": [
697                          "string",
698                          "null"
699                        ]
700                      },
701                      "address2": {
702                        "type": [
703                          "string",
704                          "null"
705                        ]
706                      },
707                      "landmark": {
708                        "type": [
709                          "string",
710                          "null"
711                        ]
712                      },
713                      "latitude": {
714                        "type": "number"
715                      },
716                      "area_code": {
717                        "type": [
718                          "string",
719                          "null"
720                        ]
721                      },
722                      "longitude": {
723                        "type": "number"
724                      },
725                      "created_at": {
726                        "type": [
727                          "string",
728                          "null"
729                        ]
730                      },
731                      "updated_at": {
732                        "type": [
733                          "string",
734                          "null"
735                        ]
736                      },
737                      "address_type": {
738                        "type": [
739                          "string",
740                          "null"
741                        ]
742                      },
743                      "contact_person": {
744                        "type": [
745                          "string",
746                          "null"
747                        ]
748                      },
749                      "address_category": {
750                        "type": [
751                          "string",
752                          "null"
753                        ]
754                      }
755                    },
756                    "description": "Delivery address information"
757                  }
758                }
759              },
760              "description": "Object containing the shipment details"
761            },
762            "coupon_json": {
763              "type": "object",
764              "description": "Applied coupon information"
765            },
766            "order_value": {
767              "type": [
768                "number",
769                "null"
770              ],
771              "description": "Value of the order"
772            },
773            "affiliate_id": {
774              "type": [
775                "string",
776                "null"
777              ],
778              "description": "Sales channel ID"
779            },
780            "coupon_value": {
781              "type": "number",
782              "description": "Value of the discount being applied by the coupon"
783            },
784            "payment_mode": {
785              "type": "object",
786              "properties": {
787                "mode": {
788                  "type": [
789                    "string",
790                    "null"
791                  ]
792                }
793              },
794              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
795            },
796            "fynd_order_id": {
797              "type": [
798                "string",
799                "null"
800              ],
801              "description": "Unique identifier of the order which is defined by Fynd"
802            },
803            "app_company_id": {
804              "type": "integer",
805              "description": "Company id of the sales channel"
806            },
807            "ordering_store": {
808              "type": "object",
809              "properties": {
810                "code": {
811                  "type": [
812                    "string",
813                    "null"
814                  ]
815                }
816              },
817              "description": "Information of the store from which order is initially placed"
818            },
819            "delivery_charges": {
820              "type": "number",
821              "description": "The amount charged for delivery apart from the product price"
822            },
823            "ordering_channel": {
824              "type": [
825                "string",
826                "null"
827              ],
828              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
829            },
830            "ordering_source": {
831              "type": "string",
832              "nullable": true,
833              "description": "To uniquely identify the source through which order has been placed."
834            },
835            "loyalty_discount_details": {
836              "type": "object",
837              "properties": {
838                "discount": {
839                  "type": "number",
840                  "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"
841                },
842                "ownership": {
843                  "type": "string",
844                  "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"
845                },
846                "is_applied": {
847                  "type": "boolean",
848                  "description": "Specifies whether the loyalty discount has been applied to the order"
849                }
850              },
851              "description": "Applied loyalty discount information"
852            },
853            "loyalty_discount": {
854              "type": "number",
855              "desctiption": "Value of the discount being applied by redeeming loyalty points"
856            }
857          },
858          "description": "Order's Information"
859        }
860      }
861    }
862  }
863}

Payload Example

1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712163424658,
10    "id": "etVPYls7l5mgn0Rb099RC3/nxuQhbEZGFM2eFfPpRqE=",
11    "name": "order",
12    "trace_id": [
13      "926446ee7a99153939756f1847c66861"
14    ],
15    "type": "placed",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "6523fa5f41f4eb4c10a1d869",
21      "ordering_store_details": {},
22      "cart_info": {
23        "cart_id": 50646042,
24        "cart_object_id": "660d889a54680fcda603b401",
25        "cart_uid": 50646042
26      },
27      "company_id": 5842,
28      "coupon": {
29        "coupon_value": 0
30      },
31      "meta": {
32        "billing_staff_details": {
33          "employee_code": null,
34          "first_name": null,
35          "id": null,
36          "last_name": null,
37          "user": null
38        },
39        "cart_id": 50646042,
40        "cart_object_id": "660d889a54680fcda603b401",
41        "comment": "",
42        "company_logo": "/company/5842/applications/6523fa5f41f4eb4c10a1d869/application/pictures/free-logo/original/b0ftwtPw4-Sephora-India.webp",
43        "conversion_rate": {
44          "base": "INR",
45          "rates": {
46            "INR": {
47              "name": "Indian Rupee",
48              "sub_unit": "Paisa",
49              "symbol": "₹",
50              "value": 1
51            }
52          },
53          "timestamp": 1712102400000
54        },
55        "currency": {
56          "currency_code": "INR",
57          "currency_name": "Indian Rupee",
58          "currency_sub_unit": "Paisa",
59          "currency_symbol": "₹"
60        },
61        "currency_symbol": "₹",
62        "custom_cart": {},
63        "custom_meta": [],
64        "device_id": null,
65        "employee_id": null,
66        "extra_meta": {},
67        "files": [],
68        "mode": "live",
69        "mongo_cart_id": 50646042,
70        "order_child_entities": [
71          "shipment",
72          "bag"
73        ],
74        "order_platform": "platform-site",
75        "order_tags": [],
76        "order_type": "HomeDelivery",
77        "ordering_store": null,
78        "payment_type": "self",
79        "platform_user_details": {
80          "platform_user_employee_code": null,
81          "platform_user_first_name": "",
82          "platform_user_id": null,
83          "platform_user_last_name": ""
84        },
85        "sales_channel_logo": "/company/5842/applications/6523fa5f41f4eb4c10a1d869/application/pictures/free-logo/original/b0ftwtPw4-Sephora-India.webp",
86        "seller_details": {
87          "country_code": "IN",
88          "currency": {
89            "code": "INR",
90            "name": "Indian Rupee",
91            "symbol": "Rs."
92          },
93          "timezone": "Asia/Kolkata"
94        },
95        "staff": {},
96        "transaction_data": {
97          "acquirer_data": {
98            "auth_code": "838359",
99            "rrn": "409416604309"
100          },
101          "amount": 115000,
102          "amount_refunded": 0,
103          "amount_transferred": 0,
104          "bank": null,
105          "base_amount": 115000,
106          "captured": true,
107          "card": {
108            "emi": false,
109            "entity": "card",
110            "id": "test",
111            "iin": "999999",
112            "international": false,
113            "issuer": "HDFC",
114            "last4": "4144",
115            "name": "",
116            "network": "Visa",
117            "sub_type": "consumer",
118            "type": "debit"
119          },
120          "card_id": "test",
121          "contact": "1111111111",
122          "created_at": 1712163402,
123          "currency": "INR",
124          "customer_id": "test",
125          "description": null,
126          "email": "test@example.com",
127          "entity": "payment",
128          "error_code": "",
129          "error_description": "",
130          "error_reason": null,
131          "error_source": null,
132          "error_step": null,
133          "fee": 2300,
134          "id": "pay_NuDu4hlGdRnSbL",
135          "international": false,
136          "invoice_id": null,
137          "method": "card",
138          "notes": [],
139          "order_id": "order_NuDu3jUVxssZVK",
140          "refund_status": null,
141          "status": "captured",
142          "tax": 0,
143          "vpa": null,
144          "wallet": null
145        },
146        "usable_credit_notes": []
147      },
148      "order_id": "FY660D8A490E9186AD5E",
149      "payment": {
150        "payment_mode": {
151          "mode": "CARD"
152        },
153        "price_breakup": {
154          "delivery_charges": 0,
155          "discount": 0,
156          "order_value": 1150
157        }
158      },
159      "payment_methods": {
160        "CARD": {
161          "amount": 1150,
162          "collect_by": "seller",
163          "meta": {
164            "id": null,
165            "logo_url": {
166              "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/B-dXunCVn-default_card.png",
167              "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/B-dXunCVn-default_card.png"
168            },
169            "merchant_code": "",
170            "payment_gateway": "Razorpay",
171            "payment_id": "FY660D8A490E9186AD5E",
172            "payment_identifier": ""
173          },
174          "mode": "CARD",
175          "name": "CARD",
176          "prices": {
177            "amount": {
178              "amount": [
179                {
180                  "currency_code": "INR",
181                  "value": 1150
182                }
183              ],
184              "is_refundable": true,
185              "taxable_amount": [
186                {
187                  "currency_code": "INR",
188                  "value": 1150
189                }
190              ],
191              "taxes": []
192            }
193          },
194          "refund_by": "seller"
195        }
196      },
197      "shipments": [
198        {
199          "bags": [
200            {
201              "affiliate_meta": {
202                "box_type": null,
203                "channel_order_id": null,
204                "channel_shipment_id": null,
205                "coupon_code": null,
206                "due_date": null,
207                "employee_discount": 0,
208                "fynd": {
209                  "fulfilment_identifier": "pulse",
210                  "fulfilment_identifiers_list": [
211                    "pulse"
212                  ]
213                },
214                "is_priority": false,
215                "loyalty_discount": 0,
216                "size_level_total_qty": 1
217              },
218              "article_json": {
219                "_id": "65aad28f0f3bdaea3c2542d8",
220                "article_code": "",
221                "article_data_population_from_ACF": "current",
222                "article_history_ACF": [
223                  {
224                    "_id": "65aad28f0f3bdaea3c2542d8",
225                    "last_updated_at_ACF": "2024-04-02 11:39:43.293832",
226                    "store_id": 22579
227                  }
228                ],
229                "article_type_ACF": "individual",
230                "available_article_count": 144,
231                "brand_id": 7342,
232                "cancellation_allowed": true,
233                "child_details": {},
234                "company_id": 5842,
235                "currency": {
236                  "code": "INR",
237                  "rate": 1
238                },
239                "dimension": {
240                  "height": 14,
241                  "is_default": true,
242                  "length": 5,
243                  "unit": "cm",
244                  "width": 5
245                },
246                "discount_percentage": 0,
247                "esp_modified": false,
248                "expiration_date": "9998-01-30 23:59:00",
249                "fragile": false,
250                "group_id": "",
251                "hsn_code": "00000001",
252                "hsn_code_id": "000000000000000000000001",
253                "identifier": {
254                  "alu": "000000000494274005",
255                  "ean": "3378872188018"
256                },
257                "is_gift": false,
258                "is_set": false,
259                "item_id": 9791610,
260                "last_updated_at_ACF": "2024-04-02 11:39:43.293805",
261                "manufacturing_time": 0,
262                "manufacturing_time_unit": "hours",
263                "mto_quantity": 0,
264                "price_effective": 1150,
265                "price_marked": 1150,
266                "quantity": 1,
267                "return_allowed": true,
268                "return_config": {
269                  "returnable": true,
270                  "time": 14,
271                  "unit": "days"
272                },
273                "seller_identifier": "000000000494274005",
274                "set": {},
275                "set_quantity": 1,
276                "size": "OS",
277                "source_ACF": "MegatronCart",
278                "store_id": 22579,
279                "transfer_price": 0,
280                "weight": {
281                  "is_default": true,
282                  "shipping": 200,
283                  "unit": "gram"
284                }
285              },
286              "brand_calculated_amount": 1150,
287              "discount": 0,
288              "item": {
289                "attributes": {
290                  "active_ingredients": [
291                    "Anti Oxidants",
292                    "Alcohol Free",
293                    "Oil Free",
294                    "Fragrance Free",
295                    "Vitamins"
296                  ],
297                  "brand_name": "SEPHORA COLLECTION",
298                  "colour-group": [
299                    "Multi"
300                  ],
301                  "custom-attribute-1": "Bath And Body",
302                  "custom-attribute-2": "Moisturiser",
303                  "custom-attribute-3": "Body",
304                  "custom-attribute-4": "Lightly-fragranced skin all day long <br>\nOur Sephora Collection Scented Moisturizing Lotion melts into the skin, leaving it soft, nourished and feeling comfortable. <br> \n<br>\nAvailable in 5 addictive fragrances. <br>\nTolerance dermatologically tested. <br>\n<br>\nFragrances <br>\n- Coconut fragrance: An invitation to a sweet escape, the coconut’s fragrance is a pure bliss. <br>\n- Argan fragrance: Feel the warmth of soothing argan notes that pamper body & mind. <br>\n- Cotton Flower fragrance: Cotton flower notes wrap you in a veil of silky softness. <br>\n- Cherry Blossom fragrance: A soft and sheer fragrance that makes you daydream about Spring’s first blossom. <br>\n- Monoi fragrance: Monoï and hot sand… the most unforgettable summers come rushing back. <br>\n<br>",
305                  "custom-attribute-5": "True",
306                  "custom-attribute-7": [
307                    "Scented Moisturizing Body Lotion"
308                  ],
309                  "custom-attribute-9": [
310                    "20230303"
311                  ],
312                  "essential": "No",
313                  "gender": [
314                    "Women"
315                  ],
316                  "how_to_use": "1. Take a small amount of body lotion </li><br>\n2. Apply to skin and gently massage in until fully absorbed\nUse daily. </li><br></li>",
317                  "ingredients": "Monoi Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Parfum (Fragrance), Carbomer, Chlorphenesin, Limonene, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Cocos Nucifera (Coconut) Oil, Linalool, Tetrasodium Glutamate Diacetate, Citric Acid, Gardenia Tahitensis Flower, Tocopherol.\n\nCherry Blossom Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Citric Acid, Prunus Cerasus (Bitter Cherry) Flower Extract, Sodium Benzoate, Tocopherol.\n\nCoconut Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Cetearyl Alcohol, Parfum (Fragrance), Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Cocos Nucifera (Coconut) Fruit Juice, Citric Acid, Tocopherol, Methyl Anthranilate, Sodium Benzoate, Potassium Sorbate.\n\nCotton Flower Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Citric Acid, Gossypium Herbaceum (Cotton) Extract, Tocopherol, Sodium Benzoate, Potassium Sorbate.\n\nArgan Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Methyl Anthranilate, Argania Spinosa Kernel Oil, Citric Acid, Tocopherol.",
318                  "is-primary-variant": "No",
319                  "is-sample-product": "No",
320                  "marketer-address": "test address",
321                  "marketer-name": "Sephora Cosmetics Private limited",
322                  "mask_type": "The formula is vegan</li><li>and contains 96% ingredients of natural origin. <br>A pack developed using a responsible approach: <br> The bottle is made with 43% recycled plastic. <br><br></li><li>Free from animal-derived ingredients</li><li>",
323                  "media": [],
324                  "name": "Scented Moisturizing Body Lotion • Cherry Blossom",
325                  "net-quantity": "1 N",
326                  "pack-size": "Cherry Blossom",
327                  "primary_color": "Multi",
328                  "primary_color_hex": "None",
329                  "product-formula": [
330                    "Lotion"
331                  ]
332                },
333                "branch_url": null,
334                "brand": "SEPHORA COLLECTION",
335                "brand_id": 7342,
336                "can_cancel": true,
337                "can_return": true,
338                "code": "7024780",
339                "color": null,
340                "gender": null,
341                "id": 9791610,
342                "images": [
343                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/XuJCX1gbtc-000000000494274005_1.png",
344                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/57CiG9ItM-000000000494274005_2.jpg",
345                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/J2-iHBZe7B-000000000494274005_3.jpg"
346                ],
347                "l1_category": [
348                  "Personal Care"
349                ],
350                "l1_category_id": 666,
351                "l2_category": [
352                  "Face Care"
353                ],
354                "l2_category_id": 670,
355                "l3_category": 756,
356                "l3_category_name": "Moisturizer",
357                "last_updated_at": "2024-04-03T22:26:42+00:00",
358                "meta": {
359                  "departments": [
360                    4
361                  ],
362                  "tags": [
363                    "No Discount",
364                    "Bath And Body-Moisturiser",
365                    "Bath And Body-Moisturiser-Body",
366                    "Bath And Body"
367                  ]
368                },
369                "name": "Scented Moisturizing Body Lotion • Cherry Blossom",
370                "slug_key": "sephora-collection-scented-moisturizing-body-lotion-v-cherry-blossom",
371                "webstore_product_url": null
372              },
373              "quantity": 1,
374              "store": {
375                "code": "S0LJ"
376              }
377            }
378          ],
379          "billing_address_json": {
380            "address": ", Opp. Akruti Soc.",
381            "address1": "test data",
382            "address2": "",
383            "address_category": "",
384            "address_type": "Home",
385            "area": "Sama-Savli Road",
386            "area_code": "390008",
387            "area_code_slug": "pincode",
388            "city": "Vadodara",
389            "contact_person": "test test",
390            "country": "India",
391            "country_code": "+91",
392            "country_iso_code": "IN",
393            "country_phone_code": "+91",
394            "created_at": "2024-04-03 22:26:41",
395            "delivery_address_id": 5787620,
396            "display_address": "390008\nIndia",
397            "email": "test@example.com",
398            "geo_location": {
399              "latitude": 22.3216309,
400              "longitude": 73.19248639999999
401            },
402            "id": "660d8a1f4cc1ca0eb22c5b48",
403            "landmark": " Bank",
404            "latitude": 22.3216309,
405            "longitude": 73.19248639999999,
406            "name": "Tara Contractor",
407            "phone": "1111111111",
408            "pincode": "390008",
409            "sector": "",
410            "state": "Gujarat",
411            "state_code": "",
412            "uid": 5787620,
413            "updated_at": "2024-04-03 22:26:41",
414            "user_id": "660d87ea523a1f658c238042",
415            "version": "1.0"
416          },
417          "delivery_address_json": {
418            "address": " Bank, Opp. Akruti Soc.",
419            "address1": " test data",
420            "address2": "",
421            "address_category": "",
422            "address_type": "Home",
423            "area": "Sama-Savli Road",
424            "area_code": "390008",
425            "area_code_slug": "pincode",
426            "city": "Vadodara",
427            "contact_person": "test test",
428            "country": "India",
429            "country_code": "+91",
430            "country_iso_code": "IN",
431            "country_phone_code": "+91",
432            "created_at": "2024-04-03 22:26:41",
433            "delivery_address_id": 5787620,
434            "display_address": " 390008\nIndia",
435            "email": "test@example.com",
436            "geo_location": {
437              "latitude": 22.3216309,
438              "longitude": 73.19248639999999
439            },
440            "id": "660d8a1f4cc1ca0eb22c5b48",
441            "landmark": "Behind Axis Bank",
442            "latitude": 22.3216309,
443            "longitude": 73.19248639999999,
444            "name": "Tara Contractor",
445            "phone": "1111111111",
446            "pincode": "390008",
447            "sector": "",
448            "state": "Gujarat",
449            "state_code": "",
450            "uid": 5787620,
451            "updated_at": "2024-04-03 22:26:41",
452            "user_id": 18916007,
453            "version": "1.0"
454          },
455          "id": "17121634018461033725"
456        }
457      ],
458      "status": "placed",
459      "user": {
460        "email": "test@example.com",
461        "external_customer_id": null,
462        "first_name": "test",
463        "gender": "female",
464        "id": 18916007,
465        "is_anonymous_user": false,
466        "last_name": "C",
467        "meta": {
468          "country_phone_code": "91"
469        },
470        "mobile": "1111111111",
471        "mongo_user_id": "660d87ea523a1f658c238042",
472        "user_oid": "660d87ea523a1f658c238042"
473      }
474    }
475  }
476}

Order/order/pending/v1

This event is triggered when order is pending

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

meta

object

Properties

order_platform

string|null

Platform from where order is placed. marketplace/platform-site/platform-pos

user

object|null

Purchaser's Details such as name, last name, mobile no. and email

Properties

mobile

string

last_name

string|null

first_name

string|null

status

string|null

State of the order, e.g. placed, confirmed, cancelled

discount

number

Discount received on the shipment

shipments

array of object

Object containing the shipment details

Array of Properties

string|null

Unique shipment no. that is auto-generated

bags

array of object

Details of all the products/articles in a shipment

Array of Properties

item

object

Properties

name

string|null

The name of the item being referenced

meta

object

Meta data related to bag item

Properties

group_id

string|null

Group ID of the bag, used in case of promotion/bundle products to group the bags

gift_card

object

docket_number

string|null

Unique Identifier for the bags per shipment

partial_can_ret

boolean

Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)

store

object

Fulfilling store information related of the shipment

Properties

name

string|null

Name of the store

discount

number|null

Discount received on the individual bag

quantity

integer|null

Quantity of the bag

article_json

object

Article's attribute information, contains attributes information of the article

Properties

identifier

object

Product Identifier details, contains ean/sku

Properties

ean

string|null

affiliate_meta

object

Sales channel meta data information for the bag

Properties

fynd

object

Properties

fulfilment_identifier

string|null

fulfilment_identifiers_list

array|object

box_type

null

coupon_code

string|null

is_priority

boolean

loyalty_discount

number|null

employee_discount

integer|null

size_level_total_qty

integer|null

brand_calculated_amount

number

Effective selling price - Brand's additional discounts

meta

object

Shipment meta data information

Properties

dp_id

string|null

Delivery Partner id that is going to process the shipment

weight

number|null

Weight of the shipment

external

object|null

formatted

object

formatted max and min expected delivery date

Properties

max

string|null

max expected delivery date

min

string|null

min expected delivery date

lock_data

object

Shipment lock information.

Properties

mto

boolean

Made to Order shipment (seller will start production after order placement)

locked

boolean

If shipment is locked or not.

lock_message

string|null

Shipment Lock message, contains reason for locking shipment

timestamp

object

timestamp of expected delivery date

bag_weight

object

debug_info

object

dp_options

object

All available delivery partner options for the the shipment

order_type

string|null

dp_sort_key

string|null

parent_dp_id

string|null

shipping_zone

string|null

packaging_name

string|null

shipment_weight

integer

Total weight of the shipment in Grams

assign_dp_from_sb

boolean

same_store_available

boolean

Is Ordering and Fulfilling store are same for the shipemnt

fulfilment_priority_text

string|null

shipment_chargeable_weight

number

Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater

shipment_volumetric_weight

number|null

Dimensional weight of the shipment, calculated using length, width and height of a package.

auto_trigger_dp_assignment_ACF

boolean

Will Delivery Partner Auto Assigned or not From Stormbreaker

billing_address_json

object

Address by which the invoice is created

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

delivery_address_json

object

Delivery address information

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

coupon_json

object

Applied coupon information

order_value

number|null

Value of the order

affiliate_id

string|null

Sales channel ID

coupon_value

number

Value of the discount being applied by the coupon

payment_mode

object

Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.

Properties

mode

string|null

fynd_order_id

string|null

Unique identifier of the order which is defined by Fynd

app_company_id

integer

Company id of the sales channel

ordering_store

object

Information of the store from which order is initially placed

Properties

code

string|null

delivery_charges

number

The amount charged for delivery apart from the product price

ordering_channel

string|null

The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.

ordering_source

string

Nullable

To uniquely identify the source through which order has been placed.

loyalty_discount_details

object

Applied loyalty discount information

Properties

discount

number

Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed

ownership

string

Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace

is_applied

boolean

Specifies whether the loyalty discount has been applied to the order

loyalty_discount

number

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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "properties": {
83            "meta": {
84              "type": "object",
85              "properties": {
86                "order_platform": {
87                  "type": [
88                    "string",
89                    "null"
90                  ],
91                  "description": "Platform from where order is placed. marketplace/platform-site/platform-pos"
92                }
93              }
94            },
95            "user": {
96              "type": [
97                "object",
98                "null"
99              ],
100              "properties": {
101                "mobile": {
102                  "type": "string"
103                },
104                "last_name": {
105                  "type": [
106                    "string",
107                    "null"
108                  ]
109                },
110                "first_name": {
111                  "type": [
112                    "string",
113                    "null"
114                  ]
115                }
116              },
117              "description": "Purchaser's Details such as name, last name, mobile no. and email"
118            },
119            "status": {
120              "type": [
121                "string",
122                "null"
123              ],
124              "description": "State of the order, e.g. placed, confirmed, cancelled"
125            },
126            "discount": {
127              "type": "number",
128              "description": "Discount received on the shipment"
129            },
130            "shipments": {
131              "type": "array",
132              "items": {
133                "type": "object",
134                "properties": {
135                  "id": {
136                    "type": [
137                      "string",
138                      "null"
139                    ],
140                    "description": "Unique shipment no. that is auto-generated"
141                  },
142                  "bags": {
143                    "type": "array",
144                    "description": "Details of all the products/articles in a shipment",
145                    "items": {
146                      "type": "object",
147                      "properties": {
148                        "item": {
149                          "type": "object",
150                          "properties": {
151                            "name": {
152                              "type": [
153                                "string",
154                                "null"
155                              ],
156                              "description": "The name of the item being referenced"
157                            }
158                          }
159                        },
160                        "meta": {
161                          "type": "object",
162                          "properties": {
163                            "group_id": {
164                              "type": [
165                                "string",
166                                "null"
167                              ],
168                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
169                            },
170                            "gift_card": {
171                              "type": "object"
172                            },
173                            "docket_number": {
174                              "type": [
175                                "string",
176                                "null"
177                              ],
178                              "description": "Unique Identifier for the bags per shipment"
179                            },
180                            "partial_can_ret": {
181                              "type": "boolean",
182                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
183                            }
184                          },
185                          "description": "Meta data related to bag item"
186                        },
187                        "store": {
188                          "type": "object",
189                          "properties": {
190                            "name": {
191                              "type": [
192                                "string",
193                                "null"
194                              ],
195                              "description": "Name of the store"
196                            }
197                          },
198                          "description": "Fulfilling store information related of the shipment"
199                        },
200                        "discount": {
201                          "type": [
202                            "number",
203                            "null"
204                          ],
205                          "description": "Discount received on the individual bag"
206                        },
207                        "quantity": {
208                          "type": [
209                            "integer",
210                            "null"
211                          ],
212                          "description": "Quantity of the bag"
213                        },
214                        "article_json": {
215                          "type": "object",
216                          "properties": {
217                            "identifier": {
218                              "type": "object",
219                              "properties": {
220                                "ean": {
221                                  "type": [
222                                    "string",
223                                    "null"
224                                  ]
225                                }
226                              },
227                              "description": "Product Identifier details, contains ean/sku"
228                            }
229                          },
230                          "description": "Article's attribute information, contains attributes information of the article"
231                        },
232                        "affiliate_meta": {
233                          "type": "object",
234                          "properties": {
235                            "fynd": {
236                              "type": "object",
237                              "properties": {
238                                "fulfilment_identifier": {
239                                  "type": [
240                                    "string",
241                                    "null"
242                                  ]
243                                },
244                                "fulfilment_identifiers_list": {
245                                  "type": [
246                                    "array",
247                                    "object"
248                                  ]
249                                }
250                              }
251                            },
252                            "box_type": {
253                              "type": "null"
254                            },
255                            "coupon_code": {
256                              "type": [
257                                "string",
258                                "null"
259                              ]
260                            },
261                            "is_priority": {
262                              "type": "boolean"
263                            },
264                            "loyalty_discount": {
265                              "type": [
266                                "number",
267                                "null"
268                              ]
269                            },
270                            "employee_discount": {
271                              "type": [
272                                "integer",
273                                "null"
274                              ]
275                            },
276                            "size_level_total_qty": {
277                              "type": [
278                                "integer",
279                                "null"
280                              ]
281                            }
282                          },
283                          "description": "Sales channel meta data information for the bag"
284                        },
285                        "brand_calculated_amount": {
286                          "type": "number",
287                          "description": "Effective selling price  - Brand's additional discounts"
288                        }
289                      }
290                    }
291                  },
292                  "meta": {
293                    "type": "object",
294                    "properties": {
295                      "dp_id": {
296                        "type": [
297                          "string",
298                          "null"
299                        ],
300                        "description": "Delivery Partner id that is going to process the shipment"
301                      },
302                      "weight": {
303                        "type": [
304                          "number",
305                          "null"
306                        ],
307                        "description": "Weight of the shipment"
308                      },
309                      "external": {
310                        "type": [
311                          "object",
312                          "null"
313                        ]
314                      },
315                      "formatted": {
316                        "type": "object",
317                        "properties": {
318                          "max": {
319                            "type": [
320                              "string",
321                              "null"
322                            ],
323                            "description": "max expected delivery date"
324                          },
325                          "min": {
326                            "type": [
327                              "string",
328                              "null"
329                            ],
330                            "description": "min expected delivery date"
331                          }
332                        },
333                        "description": "formatted max and min expected delivery date"
334                      },
335                      "lock_data": {
336                        "type": "object",
337                        "properties": {
338                          "mto": {
339                            "type": "boolean",
340                            "description": "Made to Order shipment (seller will start production after order placement)"
341                          },
342                          "locked": {
343                            "type": "boolean",
344                            "description": "If shipment is locked or not."
345                          },
346                          "lock_message": {
347                            "type": [
348                              "string",
349                              "null"
350                            ],
351                            "description": "Shipment Lock message, contains reason for locking shipment"
352                          }
353                        },
354                        "description": "Shipment lock information."
355                      },
356                      "timestamp": {
357                        "type": "object",
358                        "description": "timestamp of expected delivery date"
359                      },
360                      "bag_weight": {
361                        "type": "object"
362                      },
363                      "debug_info": {
364                        "type": "object"
365                      },
366                      "dp_options": {
367                        "type": "object",
368                        "description": "All available delivery partner options for the the shipment"
369                      },
370                      "order_type": {
371                        "type": [
372                          "string",
373                          "null"
374                        ],
375                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.\n"
376                      },
377                      "dp_sort_key": {
378                        "type": [
379                          "string",
380                          "null"
381                        ]
382                      },
383                      "parent_dp_id": {
384                        "type": [
385                          "string",
386                          "null"
387                        ]
388                      },
389                      "shipping_zone": {
390                        "type": [
391                          "string",
392                          "null"
393                        ]
394                      },
395                      "packaging_name": {
396                        "type": [
397                          "string",
398                          "null"
399                        ]
400                      },
401                      "shipment_weight": {
402                        "type": "integer",
403                        "description": "Total weight of the shipment in Grams"
404                      },
405                      "assign_dp_from_sb": {
406                        "type": "boolean"
407                      },
408                      "same_store_available": {
409                        "type": "boolean",
410                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
411                      },
412                      "fulfilment_priority_text": {
413                        "type": [
414                          "string",
415                          "null"
416                        ]
417                      },
418                      "shipment_chargeable_weight": {
419                        "type": "number",
420                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
421                      },
422                      "shipment_volumetric_weight": {
423                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
424                        "type": [
425                          "number",
426                          "null"
427                        ]
428                      },
429                      "auto_trigger_dp_assignment_ACF": {
430                        "type": "boolean",
431                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
432                      }
433                    },
434                    "description": "Shipment meta data information"
435                  },
436                  "billing_address_json": {
437                    "type": "object",
438                    "properties": {
439                      "area": {
440                        "type": [
441                          "string",
442                          "null"
443                        ]
444                      },
445                      "city": {
446                        "type": [
447                          "string",
448                          "null"
449                        ]
450                      },
451                      "name": {
452                        "type": [
453                          "string",
454                          "null"
455                        ]
456                      },
457                      "email": {
458                        "type": [
459                          "string",
460                          "null"
461                        ]
462                      },
463                      "phone": {
464                        "type": [
465                          "string",
466                          "null"
467                        ]
468                      },
469                      "state": {
470                        "type": [
471                          "string",
472                          "null"
473                        ]
474                      },
475                      "address": {
476                        "type": [
477                          "string",
478                          "null"
479                        ]
480                      },
481                      "country": {
482                        "type": [
483                          "string",
484                          "null"
485                        ]
486                      },
487                      "pincode": {
488                        "type": [
489                          "string",
490                          "null"
491                        ]
492                      },
493                      "version": {
494                        "type": [
495                          "string",
496                          "null"
497                        ]
498                      },
499                      "address1": {
500                        "type": [
501                          "string",
502                          "null"
503                        ]
504                      },
505                      "address2": {
506                        "type": [
507                          "string",
508                          "null"
509                        ]
510                      },
511                      "landmark": {
512                        "type": [
513                          "string",
514                          "null"
515                        ]
516                      },
517                      "latitude": {
518                        "type": "number"
519                      },
520                      "area_code": {
521                        "type": [
522                          "string",
523                          "null"
524                        ]
525                      },
526                      "longitude": {
527                        "type": "number"
528                      },
529                      "created_at": {
530                        "type": [
531                          "string",
532                          "null"
533                        ]
534                      },
535                      "updated_at": {
536                        "type": [
537                          "string",
538                          "null"
539                        ]
540                      },
541                      "address_type": {
542                        "type": [
543                          "string",
544                          "null"
545                        ]
546                      },
547                      "contact_person": {
548                        "type": [
549                          "string",
550                          "null"
551                        ]
552                      },
553                      "address_category": {
554                        "type": [
555                          "string",
556                          "null"
557                        ]
558                      }
559                    },
560                    "description": "Address by which the invoice is created"
561                  },
562                  "delivery_address_json": {
563                    "type": "object",
564                    "properties": {
565                      "area": {
566                        "type": [
567                          "string",
568                          "null"
569                        ]
570                      },
571                      "city": {
572                        "type": [
573                          "string",
574                          "null"
575                        ]
576                      },
577                      "name": {
578                        "type": [
579                          "string",
580                          "null"
581                        ]
582                      },
583                      "email": {
584                        "type": [
585                          "string",
586                          "null"
587                        ]
588                      },
589                      "phone": {
590                        "type": [
591                          "string",
592                          "null"
593                        ]
594                      },
595                      "state": {
596                        "type": [
597                          "string",
598                          "null"
599                        ]
600                      },
601                      "address": {
602                        "type": [
603                          "string",
604                          "null"
605                        ]
606                      },
607                      "country": {
608                        "type": [
609                          "string",
610                          "null"
611                        ]
612                      },
613                      "pincode": {
614                        "type": [
615                          "string",
616                          "null"
617                        ]
618                      },
619                      "version": {
620                        "type": [
621                          "string",
622                          "null"
623                        ]
624                      },
625                      "address1": {
626                        "type": [
627                          "string",
628                          "null"
629                        ]
630                      },
631                      "address2": {
632                        "type": [
633                          "string",
634                          "null"
635                        ]
636                      },
637                      "landmark": {
638                        "type": [
639                          "string",
640                          "null"
641                        ]
642                      },
643                      "latitude": {
644                        "type": "number"
645                      },
646                      "area_code": {
647                        "type": [
648                          "string",
649                          "null"
650                        ]
651                      },
652                      "longitude": {
653                        "type": "number"
654                      },
655                      "created_at": {
656                        "type": [
657                          "string",
658                          "null"
659                        ]
660                      },
661                      "updated_at": {
662                        "type": [
663                          "string",
664                          "null"
665                        ]
666                      },
667                      "address_type": {
668                        "type": [
669                          "string",
670                          "null"
671                        ]
672                      },
673                      "contact_person": {
674                        "type": [
675                          "string",
676                          "null"
677                        ]
678                      },
679                      "address_category": {
680                        "type": [
681                          "string",
682                          "null"
683                        ]
684                      }
685                    },
686                    "description": "Delivery address information"
687                  }
688                }
689              },
690              "description": "Object containing the shipment details"
691            },
692            "coupon_json": {
693              "type": "object",
694              "description": "Applied coupon information"
695            },
696            "order_value": {
697              "type": [
698                "number",
699                "null"
700              ],
701              "description": "Value of the order"
702            },
703            "affiliate_id": {
704              "type": [
705                "string",
706                "null"
707              ],
708              "description": "Sales channel ID"
709            },
710            "coupon_value": {
711              "type": "number",
712              "description": "Value of the discount being applied by the coupon"
713            },
714            "payment_mode": {
715              "type": "object",
716              "properties": {
717                "mode": {
718                  "type": [
719                    "string",
720                    "null"
721                  ]
722                }
723              },
724              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
725            },
726            "fynd_order_id": {
727              "type": [
728                "string",
729                "null"
730              ],
731              "description": "Unique identifier of the order which is defined by Fynd"
732            },
733            "app_company_id": {
734              "type": "integer",
735              "description": "Company id of the sales channel"
736            },
737            "ordering_store": {
738              "type": "object",
739              "properties": {
740                "code": {
741                  "type": [
742                    "string",
743                    "null"
744                  ]
745                }
746              },
747              "description": "Information of the store from which order is initially placed"
748            },
749            "delivery_charges": {
750              "type": "number",
751              "description": "The amount charged for delivery apart from the product price"
752            },
753            "ordering_channel": {
754              "type": [
755                "string",
756                "null"
757              ],
758              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
759            },
760            "ordering_source": {
761              "type": "string",
762              "nullable": true,
763              "description": "To uniquely identify the source through which order has been placed."
764            },
765            "loyalty_discount_details": {
766              "type": "object",
767              "properties": {
768                "discount": {
769                  "type": "number",
770                  "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"
771                },
772                "ownership": {
773                  "type": "string",
774                  "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"
775                },
776                "is_applied": {
777                  "type": "boolean",
778                  "description": "Specifies whether the loyalty discount has been applied to the order"
779                }
780              },
781              "description": "Applied loyalty discount information"
782            },
783            "loyalty_discount": {
784              "type": "number",
785              "desctiption": "Value of the discount being applied by redeeming loyalty points"
786            }
787          },
788          "description": "Order's Information"
789        }
790      }
791    }
792  }
793}

Payload Example

1{
2  "application_id": "63f893a94adb0bbd79de0344",
3  "company_id": 4641,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712163281916,
10    "id": "NTb9VHA1Kw+COIF9TbM07XmJHqUCkxS7Q9cwUIFZjbQ=",
11    "name": "order",
12    "trace_id": [
13      "0000000000000000dadf1f76b2d8e452"
14    ],
15    "type": "pending",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "63f893a94adb0bbd79de0344",
21      "cart_info": {
22        "cart_uid": 1000000007
23      },
24      "company_id": 4641,
25      "coupon": {
26        "coupon_value": 0
27      },
28      "meta": {
29        "billing_staff_details": {},
30        "charges": [
31          {
32            "amount": {
33              "currency": "INR",
34              "value": 0
35            },
36            "code": "",
37            "name": "COD Charges",
38            "type": "cod_charges"
39          },
40          {
41            "amount": {
42              "currency": "INR",
43              "value": 0
44            },
45            "code": "",
46            "name": "Delivery Charges",
47            "type": "delivery_charges"
48          }
49        ],
50        "company_logo": null,
51        "conversion_rate": {
52          "base": "INR",
53          "rates": {
54            "INR": {
55              "name": "Indian Rupee",
56              "sub_unit": "Paisa",
57              "symbol": "₹",
58              "value": 1
59            }
60          },
61          "timestamp": 1712057944.367167
62        },
63        "currency": {
64          "currency_code": "INR",
65          "currency_name": "Indian Rupee",
66          "currency_sub_unit": "Paisa",
67          "currency_symbol": "₹"
68        },
69        "currency_info": {},
70        "employee_id": "",
71        "external_creation_date": "1712183080",
72        "extra_meta": {},
73        "mongo_cart_id": 1000000007,
74        "order_child_entities": [
75          "bag",
76          "shipment"
77        ],
78        "order_type": "new",
79        "ordering_channel_logo": "",
80        "ordering_store": null,
81        "payment_type": null,
82        "platform_user_details": {},
83        "sales_channel_logo": "",
84        "seller_details": {},
85        "staff": {}
86      },
87      "order_id": "FYMP660D89D10161D965",
88      "payment": {
89        "payment_mode": {
90          "mode": "PP"
91        },
92        "price_breakup": {
93          "delivery_charges": 0,
94          "discount": 0,
95          "order_value": 0
96        }
97      },
98      "payment_methods": {
99        "PP": {
100          "amount": 0,
101          "collect_by": "seller",
102          "meta": {},
103          "mode": "PP",
104          "name": "PartnerPay",
105          "refund_by": "seller"
106        },
107        "Prepaid_Payments": {
108          "amount": 51.8,
109          "collect_by": "seller",
110          "meta": {},
111          "mode": "Prepaid_Payments",
112          "name": "Prepaid_Payments",
113          "refund_by": "seller"
114        }
115      },
116      "shipments": [
117        {
118          "bags": [
119            {
120              "affiliate_meta": {
121                "box_type": null,
122                "channel_order_id": null,
123                "channel_shipment_id": null,
124                "coupon_code": null,
125                "due_date": null,
126                "employee_discount": 0,
127                "fynd": {
128                  "fulfilment_identifier": "pulse",
129                  "fulfilment_identifiers_list": [
130                    "pulse"
131                  ]
132                },
133                "is_priority": false,
134                "loyalty_discount": 0,
135                "size_level_total_qty": null
136              },
137              "article_json": {
138                "_id": "64977dde20b77e320db1587d",
139                "article_code": "",
140                "article_data_population_from_ACF": "current",
141                "article_history_ACF": [
142                  {
143                    "_id": "64977dde20b77e320db1587d",
144                    "last_updated_at_ACF": "2024-04-02 11:39:05.512352",
145                    "store_id": 20091
146                  }
147                ],
148                "article_type_ACF": "individual",
149                "available_article_count": 1695,
150                "brand_id": "",
151                "cancellation_allowed": true,
152                "child_details": {},
153                "company_id": 4641,
154                "currency": {},
155                "dimension": {},
156                "discount_percentage": 131,
157                "esp_modified": "",
158                "expiration_date": null,
159                "fragile": "",
160                "group_id": "",
161                "hsn_code": "20081100",
162                "hsn_code_id": "627782b45e4c6fdbc8be2a1e",
163                "identifier": {
164                  "sku_code": "O12502_1"
165                },
166                "is_gift": false,
167                "is_set": "",
168                "item_id": 9378052,
169                "last_updated_at_ACF": "2024-04-02 11:39:05.512328",
170                "manufacturing_time": 0,
171                "manufacturing_time_unit": "hours",
172                "mto_quantity": "",
173                "price_effective": 518,
174                "price_marked": 649,
175                "quantity": 1,
176                "return_allowed": true,
177                "return_config": {
178                  "returnable": true,
179                  "time": 1,
180                  "unit": "days"
181                },
182                "seller_identifier": "O12502_1",
183                "set": {},
184                "set_quantity": 1,
185                "size": "L",
186                "source_ACF": "MegatronCart",
187                "store_id": 20091,
188                "transfer_price": 0,
189                "weight": {}
190              },
191              "brand_calculated_amount": 518,
192              "discount": 131,
193              "item": {
194                "attributes": {
195                  "brand_name": "Myfitness",
196                  "essential": "No",
197                  "marketer-address": "test adderss0",
198                  "marketer-name": "TANVI Healthcare",
199                  "media": [],
200                  "name": "MyFitness Original crunchy Peanut Butter 1250 gms",
201                  "net-quantity": "1 N"
202                },
203                "branch_url": null,
204                "brand": "Myfitness",
205                "brand_id": 6113,
206                "can_cancel": true,
207                "can_return": true,
208                "code": "RVHNNNVN7Q",
209                "color": null,
210                "gender": null,
211                "id": 9378052,
212                "images": [
213                  "https://fynd-static.s3.amazonaws.com/common/default_item_image.jpg"
214                ],
215                "l1_category": [
216                  "Beverages"
217                ],
218                "l1_category_id": 1876,
219                "l2_category": [
220                  "Energy & Soft Drinks"
221                ],
222                "l2_category_id": 1902,
223                "l3_category": 2078,
224                "l3_category_name": "Aerated Drinks",
225                "last_updated_at": "2024-04-03T22:24:42+00:00",
226                "meta": {
227                  "departments": [
228                    18
229                  ],
230                  "tags": []
231                },
232                "name": "MyFitness Original crunchy Peanut Butter 1250 gms",
233                "slug_key": "myfitness-original-crunchy-peanut-butter-1250-gms-9378052",
234                "webstore_product_url": null
235              },
236              "quantity": 1,
237              "store": {
238                "code": "3PPBZXSO7FC10"
239              }
240            }
241          ],
242          "billing_address_json": {
243            "address": "  test address",
244            "address1": " test address",
245            "address2": "",
246            "address_category": "",
247            "address_type": "home",
248            "area": "",
249            "area_code": "",
250            "area_code_slug": "",
251            "city": "Sonipat",
252            "contact_person": "test test ",
253            "country": "India",
254            "country_iso_code": "IN",
255            "country_phone_code": null,
256            "created_at": "2024-04-03 22:24:41",
257            "display_address": " 131001\nIndia",
258            "email": "test@example.com",
259            "first_name": "test test",
260            "geo_location": {},
261            "landmark": "",
262            "last_name": "",
263            "latitude": 0,
264            "longitude": 0,
265            "name": "",
266            "phone": "1111111111",
267            "pincode": "131001",
268            "state": "Haryana",
269            "updated_at": "2024-04-03 22:24:41",
270            "version": "1.0"
271          },
272          "delivery_address_json": {
273            "address": "  electric works",
274            "address1": " electric works\nSonipat Haryana 131001\nIndia",
275            "address2": "",
276            "address_category": "",
277            "address_type": "home",
278            "area": "",
279            "area_code": "",
280            "area_code_slug": "",
281            "city": "Sonipat",
282            "contact_person": "test test ",
283            "country": "India",
284            "country_iso_code": "IN",
285            "country_phone_code": null,
286            "created_at": "2024-04-03 22:24:41",
287            "display_address": " electric works\nSonipat Haryana 131001\nIndia",
288            "email": "test@example.com",
289            "first_name": "test test",
290            "geo_location": {},
291            "landmark": "",
292            "last_name": "",
293            "latitude": 0,
294            "longitude": 0,
295            "name": "",
296            "phone": "1111111111",
297            "pincode": "131001",
298            "state": "Haryana",
299            "updated_at": "2024-04-03 22:24:41",
300            "user_id": 18245977,
301            "version": "1.0"
302          },
303          "id": "17121632817081880021"
304        }
305      ],
306      "status": "pending",
307      "user": {
308        "email": "test@example.com",
309        "external_customer_id": null,
310        "first_name": "test test",
311        "gender": null,
312        "id": 18245977,
313        "is_anonymous_user": false,
314        "last_name": "",
315        "meta": {
316          "country_phone_code": ""
317        },
318        "mobile": "1111111111",
319        "mongo_user_id": null,
320        "user_oid": null
321      }
322    }
323  }
324}

Order/order/payment_failed/v1

This event is triggered when order is payment_failed

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

meta

object

Meta data related to order

Properties

order_platform

string|null

user

object|null

Purchaser's Details such as name, last name, mobile no. and email

Properties

mobile

string

last_name

string|null

first_name

string|null

status

string|null

State of the order, e.g. placed, confirmed, cancelled

discount

number

Discount received on the shipment

shipments

array of object

Object containing the shipment details

Array of Properties

string|null

Unique shipment no. that is auto-generated

bags

array of object

Details of all the products/articles in a shipment

Array of Properties

item

object

Properties

name

string|null

The name of the item being referenced

meta

object

Meta data related to bag item

Properties

group_id

string|null

Group ID of the bag, used in case of promotion/bundle products to group the bags

gift_card

object

docket_number

string|null

Unique Identifier for the bags per shipment

partial_can_ret

boolean

Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)

store

object

Fulfilling store information of the shipment

Properties

name

string|null

Name of the store

discount

number|null

Discount received on the individual bag

quantity

integer|null

Quantity of the bag

article_json

object

Article's attribute information, contains attributes information of the article

Properties

identifier

object

Identifier of the article, contains ean/sku

Properties

ean

string|null

affiliate_meta

object

Sales channel meta data information for the bag

Properties

fynd

object

Properties

fulfilment_identifier

string|null

fulfilment_identifiers_list

array|object

box_type

null

coupon_code

string|null

is_priority

boolean

loyalty_discount

number|null

employee_discount

integer|null

size_level_total_qty

integer|null

brand_calculated_amount

number

Effective selling price - Brand's additional discounts

meta

object

Shipment meta data information

Properties

dp_id

string|null

Delivery Partner id that is going to process the shipment

weight

number|null

Weight of the shipment

external

object|null

formatted

object

formatted max and min expected delivery date

Properties

max

string|null

max expected delivery date

min

string|null

min expected delivery date

lock_data

object

Shipment lock information.

Properties

mto

boolean

Made to Order shipment (seller will start production after order placement)

locked

boolean

If shipment is locked or not.

lock_message

string|null

Shipment Lock message, contains reason for locking shipment

timestamp

object

timestamp of expected delivery date

bag_weight

object

debug_info

object

dp_options

object

All available delivery partner options for the the shipment

order_type

string|null

dp_sort_key

string|null

parent_dp_id

string|null

shipping_zone

string|null

packaging_name

string|null

shipment_weight

integer

Total weight of the shipment in Grams

assign_dp_from_sb

boolean

same_store_available

boolean

Is Ordering and Fulfilling store are same for the shipemnt

fulfilment_priority_text

string|null

shipment_chargeable_weight

number

Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater

shipment_volumetric_weight

number|null

Dimensional weight of the shipment, calculated using length, width and height of a package.

auto_trigger_dp_assignment_ACF

boolean

Will Delivery Partner Auto Assigned or not From Stormbreaker

billing_address_json

object

Address by which the invoice is created

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

delivery_address_json

object

Delivery address information

Properties

area

string|null

city

string|null

name

string|null

phone

string|null

state

string|null

address

string|null

country

string|null

pincode

string|null

version

string|null

address1

string|null

address2

string|null

landmark

string|null

latitude

number

area_code

string|null

longitude

number

created_at

string|null

updated_at

string|null

address_type

string|null

contact_person

string|null

address_category

string|null

coupon_json

object

Applied coupon information

order_value

number|null

Value of the order

affiliate_id

string|null

Sales channel ID

coupon_value

number

Value of the discount being applied by the coupon

payment_mode

object

Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.

Properties

mode

string|null

fynd_order_id

string|null

Unique identifier of the order which is defined by Fynd

app_company_id

integer

Company id of the sales channel

ordering_store

object

Information of the store from which order is initially placed

Properties

code

string|null

delivery_charges

number

The amount charged for delivery apart from the product price

ordering_channel

string|null

The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.

ordering_source

string

Nullable

To uniquely identify the source through which order has been placed.

loyalty_discount_details

object

Applied loyalty discount information

Properties

discount

number

Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed

ownership

string

Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace

is_applied

boolean

Specifies whether the loyalty discount has been applied to the order

loyalty_discount

number

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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "description": "Order's Information",
83          "properties": {
84            "meta": {
85              "type": "object",
86              "properties": {
87                "order_platform": {
88                  "type": [
89                    "string",
90                    "null"
91                  ]
92                }
93              },
94              "description": "Meta data related to order"
95            },
96            "user": {
97              "type": [
98                "object",
99                "null"
100              ],
101              "properties": {
102                "mobile": {
103                  "type": "string"
104                },
105                "last_name": {
106                  "type": [
107                    "string",
108                    "null"
109                  ]
110                },
111                "first_name": {
112                  "type": [
113                    "string",
114                    "null"
115                  ]
116                }
117              },
118              "description": "Purchaser's Details such as name, last name, mobile no. and email"
119            },
120            "status": {
121              "type": [
122                "string",
123                "null"
124              ],
125              "description": "State of the order, e.g. placed, confirmed, cancelled"
126            },
127            "discount": {
128              "type": "number",
129              "description": "Discount received on the shipment"
130            },
131            "shipments": {
132              "type": "array",
133              "items": {
134                "type": "object",
135                "properties": {
136                  "id": {
137                    "type": [
138                      "string",
139                      "null"
140                    ],
141                    "description": "Unique shipment no. that is auto-generated"
142                  },
143                  "bags": {
144                    "type": "array",
145                    "description": "Details of all the products/articles in a shipment",
146                    "items": {
147                      "type": "object",
148                      "properties": {
149                        "item": {
150                          "type": "object",
151                          "properties": {
152                            "name": {
153                              "type": [
154                                "string",
155                                "null"
156                              ],
157                              "description": "The name of the item being referenced"
158                            }
159                          }
160                        },
161                        "meta": {
162                          "type": "object",
163                          "properties": {
164                            "group_id": {
165                              "type": [
166                                "string",
167                                "null"
168                              ],
169                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
170                            },
171                            "gift_card": {
172                              "type": "object"
173                            },
174                            "docket_number": {
175                              "type": [
176                                "string",
177                                "null"
178                              ],
179                              "description": "Unique Identifier for the bags per shipment"
180                            },
181                            "partial_can_ret": {
182                              "type": "boolean",
183                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
184                            }
185                          },
186                          "description": "Meta data related to bag item"
187                        },
188                        "store": {
189                          "type": "object",
190                          "properties": {
191                            "name": {
192                              "type": [
193                                "string",
194                                "null"
195                              ],
196                              "description": "Name of the store"
197                            }
198                          },
199                          "description": "Fulfilling store information of the shipment"
200                        },
201                        "discount": {
202                          "type": [
203                            "number",
204                            "null"
205                          ],
206                          "description": "Discount received on the individual bag"
207                        },
208                        "quantity": {
209                          "type": [
210                            "integer",
211                            "null"
212                          ],
213                          "description": "Quantity of the bag"
214                        },
215                        "article_json": {
216                          "type": "object",
217                          "properties": {
218                            "identifier": {
219                              "type": "object",
220                              "properties": {
221                                "ean": {
222                                  "type": [
223                                    "string",
224                                    "null"
225                                  ]
226                                }
227                              },
228                              "description": "Identifier of the article, contains ean/sku"
229                            }
230                          },
231                          "description": "Article's attribute information, contains attributes information of the article"
232                        },
233                        "affiliate_meta": {
234                          "type": "object",
235                          "properties": {
236                            "fynd": {
237                              "type": "object",
238                              "properties": {
239                                "fulfilment_identifier": {
240                                  "type": [
241                                    "string",
242                                    "null"
243                                  ]
244                                },
245                                "fulfilment_identifiers_list": {
246                                  "type": [
247                                    "array",
248                                    "object"
249                                  ]
250                                }
251                              }
252                            },
253                            "box_type": {
254                              "type": "null"
255                            },
256                            "coupon_code": {
257                              "type": [
258                                "string",
259                                "null"
260                              ]
261                            },
262                            "is_priority": {
263                              "type": "boolean"
264                            },
265                            "loyalty_discount": {
266                              "type": [
267                                "number",
268                                "null"
269                              ]
270                            },
271                            "employee_discount": {
272                              "type": [
273                                "integer",
274                                "null"
275                              ]
276                            },
277                            "size_level_total_qty": {
278                              "type": [
279                                "integer",
280                                "null"
281                              ]
282                            }
283                          },
284                          "description": "Sales channel meta data information for the bag"
285                        },
286                        "brand_calculated_amount": {
287                          "type": "number",
288                          "description": "Effective selling price  - Brand's additional discounts"
289                        }
290                      }
291                    }
292                  },
293                  "meta": {
294                    "type": "object",
295                    "properties": {
296                      "dp_id": {
297                        "type": [
298                          "string",
299                          "null"
300                        ],
301                        "description": "Delivery Partner id that is going to process the shipment"
302                      },
303                      "weight": {
304                        "type": [
305                          "number",
306                          "null"
307                        ],
308                        "description": "Weight of the shipment"
309                      },
310                      "external": {
311                        "type": [
312                          "object",
313                          "null"
314                        ]
315                      },
316                      "formatted": {
317                        "type": "object",
318                        "properties": {
319                          "max": {
320                            "type": [
321                              "string",
322                              "null"
323                            ],
324                            "description": "max expected delivery date"
325                          },
326                          "min": {
327                            "type": [
328                              "string",
329                              "null"
330                            ],
331                            "description": "min expected delivery date"
332                          }
333                        },
334                        "description": "formatted max and min expected delivery date"
335                      },
336                      "lock_data": {
337                        "type": "object",
338                        "properties": {
339                          "mto": {
340                            "type": "boolean",
341                            "description": "Made to Order shipment (seller will start production after order placement)"
342                          },
343                          "locked": {
344                            "type": "boolean",
345                            "description": "If shipment is locked or not."
346                          },
347                          "lock_message": {
348                            "type": [
349                              "string",
350                              "null"
351                            ],
352                            "description": "Shipment Lock message, contains reason for locking shipment"
353                          }
354                        },
355                        "description": "Shipment lock information."
356                      },
357                      "timestamp": {
358                        "type": "object",
359                        "description": "timestamp of expected delivery date"
360                      },
361                      "bag_weight": {
362                        "type": "object"
363                      },
364                      "debug_info": {
365                        "type": "object"
366                      },
367                      "dp_options": {
368                        "type": "object",
369                        "description": "All available delivery partner options for the the shipment"
370                      },
371                      "order_type": {
372                        "type": [
373                          "string",
374                          "null"
375                        ],
376                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically. \n"
377                      },
378                      "dp_sort_key": {
379                        "type": [
380                          "string",
381                          "null"
382                        ]
383                      },
384                      "parent_dp_id": {
385                        "type": [
386                          "string",
387                          "null"
388                        ]
389                      },
390                      "shipping_zone": {
391                        "type": [
392                          "string",
393                          "null"
394                        ]
395                      },
396                      "packaging_name": {
397                        "type": [
398                          "string",
399                          "null"
400                        ]
401                      },
402                      "shipment_weight": {
403                        "type": "integer",
404                        "description": "Total weight of the shipment in Grams"
405                      },
406                      "assign_dp_from_sb": {
407                        "type": "boolean"
408                      },
409                      "same_store_available": {
410                        "type": "boolean",
411                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
412                      },
413                      "fulfilment_priority_text": {
414                        "type": [
415                          "string",
416                          "null"
417                        ]
418                      },
419                      "shipment_chargeable_weight": {
420                        "type": "number",
421                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
422                      },
423                      "shipment_volumetric_weight": {
424                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
425                        "type": [
426                          "number",
427                          "null"
428                        ]
429                      },
430                      "auto_trigger_dp_assignment_ACF": {
431                        "type": "boolean",
432                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
433                      }
434                    },
435                    "description": "Shipment meta data information"
436                  },
437                  "billing_address_json": {
438                    "type": "object",
439                    "properties": {
440                      "area": {
441                        "type": [
442                          "string",
443                          "null"
444                        ]
445                      },
446                      "city": {
447                        "type": [
448                          "string",
449                          "null"
450                        ]
451                      },
452                      "name": {
453                        "type": [
454                          "string",
455                          "null"
456                        ]
457                      },
458                      "email": {
459                        "type": [
460                          "string",
461                          "null"
462                        ]
463                      },
464                      "phone": {
465                        "type": [
466                          "string",
467                          "null"
468                        ]
469                      },
470                      "state": {
471                        "type": [
472                          "string",
473                          "null"
474                        ]
475                      },
476                      "address": {
477                        "type": [
478                          "string",
479                          "null"
480                        ]
481                      },
482                      "country": {
483                        "type": [
484                          "string",
485                          "null"
486                        ]
487                      },
488                      "pincode": {
489                        "type": [
490                          "string",
491                          "null"
492                        ]
493                      },
494                      "version": {
495                        "type": [
496                          "string",
497                          "null"
498                        ]
499                      },
500                      "address1": {
501                        "type": [
502                          "string",
503                          "null"
504                        ]
505                      },
506                      "address2": {
507                        "type": [
508                          "string",
509                          "null"
510                        ]
511                      },
512                      "landmark": {
513                        "type": [
514                          "string",
515                          "null"
516                        ]
517                      },
518                      "latitude": {
519                        "type": "number"
520                      },
521                      "area_code": {
522                        "type": [
523                          "string",
524                          "null"
525                        ]
526                      },
527                      "longitude": {
528                        "type": "number"
529                      },
530                      "created_at": {
531                        "type": [
532                          "string",
533                          "null"
534                        ]
535                      },
536                      "updated_at": {
537                        "type": [
538                          "string",
539                          "null"
540                        ]
541                      },
542                      "address_type": {
543                        "type": [
544                          "string",
545                          "null"
546                        ]
547                      },
548                      "contact_person": {
549                        "type": [
550                          "string",
551                          "null"
552                        ]
553                      },
554                      "address_category": {
555                        "type": [
556                          "string",
557                          "null"
558                        ]
559                      }
560                    },
561                    "description": "Address by which the invoice is created"
562                  },
563                  "delivery_address_json": {
564                    "type": "object",
565                    "properties": {
566                      "area": {
567                        "type": [
568                          "string",
569                          "null"
570                        ]
571                      },
572                      "city": {
573                        "type": [
574                          "string",
575                          "null"
576                        ]
577                      },
578                      "name": {
579                        "type": [
580                          "string",
581                          "null"
582                        ]
583                      },
584                      "email": {
585                        "type": [
586                          "string",
587                          "null"
588                        ]
589                      },
590                      "phone": {
591                        "type": [
592                          "string",
593                          "null"
594                        ]
595                      },
596                      "state": {
597                        "type": [
598                          "string",
599                          "null"
600                        ]
601                      },
602                      "address": {
603                        "type": [
604                          "string",
605                          "null"
606                        ]
607                      },
608                      "country": {
609                        "type": [
610                          "string",
611                          "null"
612                        ]
613                      },
614                      "pincode": {
615                        "type": [
616                          "string",
617                          "null"
618                        ]
619                      },
620                      "version": {
621                        "type": [
622                          "string",
623                          "null"
624                        ]
625                      },
626                      "address1": {
627                        "type": [
628                          "string",
629                          "null"
630                        ]
631                      },
632                      "address2": {
633                        "type": [
634                          "string",
635                          "null"
636                        ]
637                      },
638                      "landmark": {
639                        "type": [
640                          "string",
641                          "null"
642                        ]
643                      },
644                      "latitude": {
645                        "type": "number"
646                      },
647                      "area_code": {
648                        "type": [
649                          "string",
650                          "null"
651                        ]
652                      },
653                      "longitude": {
654                        "type": "number"
655                      },
656                      "created_at": {
657                        "type": [
658                          "string",
659                          "null"
660                        ]
661                      },
662                      "updated_at": {
663                        "type": [
664                          "string",
665                          "null"
666                        ]
667                      },
668                      "address_type": {
669                        "type": [
670                          "string",
671                          "null"
672                        ]
673                      },
674                      "contact_person": {
675                        "type": [
676                          "string",
677                          "null"
678                        ]
679                      },
680                      "address_category": {
681                        "type": [
682                          "string",
683                          "null"
684                        ]
685                      }
686                    },
687                    "description": "Delivery address information"
688                  }
689                }
690              },
691              "description": "Object containing the shipment details"
692            },
693            "coupon_json": {
694              "type": "object",
695              "description": "Applied coupon information"
696            },
697            "order_value": {
698              "type": [
699                "number",
700                "null"
701              ],
702              "description": "Value of the order"
703            },
704            "affiliate_id": {
705              "type": [
706                "string",
707                "null"
708              ],
709              "description": "Sales channel ID"
710            },
711            "coupon_value": {
712              "type": "number",
713              "description": "Value of the discount being applied by the coupon"
714            },
715            "payment_mode": {
716              "type": "object",
717              "properties": {
718                "mode": {
719                  "type": [
720                    "string",
721                    "null"
722                  ]
723                }
724              },
725              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
726            },
727            "fynd_order_id": {
728              "type": [
729                "string",
730                "null"
731              ],
732              "description": "Unique identifier of the order which is defined by Fynd"
733            },
734            "app_company_id": {
735              "type": "integer",
736              "description": "Company id of the sales channel"
737            },
738            "ordering_store": {
739              "type": "object",
740              "properties": {
741                "code": {
742                  "type": [
743                    "string",
744                    "null"
745                  ]
746                }
747              },
748              "description": "Information of the store from which order is initially placed"
749            },
750            "delivery_charges": {
751              "type": "number",
752              "description": "The amount charged for delivery apart from the product price"
753            },
754            "ordering_channel": {
755              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.",
756              "type": [
757                "string",
758                "null"
759              ]
760            },
761            "ordering_source": {
762              "type": "string",
763              "nullable": true,
764              "description": "To uniquely identify the source through which order has been placed."
765            },
766            "loyalty_discount_details": {
767              "type": "object",
768              "properties": {
769                "discount": {
770                  "type": "number",
771                  "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"
772                },
773                "ownership": {
774                  "type": "string",
775                  "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"
776                },
777                "is_applied": {
778                  "type": "boolean",
779                  "description": "Specifies whether the loyalty discount has been applied to the order"
780                }
781              },
782              "description": "Applied loyalty discount information"
783            },
784            "loyalty_discount": {
785              "type": "number",
786              "desctiption": "Value of the discount being applied by redeeming loyalty points"
787            }
788          }
789        }
790      }
791    }
792  }
793}

Payload Example

1{
2  "application_id": "62692eafbdaef6a37a1bf655",
3  "company_id": 2683,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712162539925,
10    "id": "e5kIwt3E5ufv3ef6GoGNdUDs0gksIE7gf2lzYoRgXGQ=",
11    "name": "order",
12    "trace_id": [
13      "997e8583a02212d19ee9d0557201cbbe"
14    ],
15    "type": "payment_failed",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "62692eafbdaef6a37a1bf655",
21      "cart_info": {
22        "cart_id": 34742656,
23        "cart_object_id": "660d862b3050b38aaf0e9e66",
24        "cart_uid": 34742656
25      },
26      "company_id": 2683,
27      "coupon": {
28        "coupon_value": 0
29      },
30      "meta": {
31        "billing_staff_details": {
32          "employee_code": null,
33          "first_name": null,
34          "id": null,
35          "last_name": null,
36          "user": null
37        },
38        "cart_id": 34742656,
39        "cart_object_id": "660d862b3050b38aaf0e9e66",
40        "comment": "",
41        "company_logo": "/company/2683/applications/62692eafbdaef6a37a1bf655/application/pictures/free-logo/original/Y-jbdLeDF-Suresh-Fashion-Hub.png",
42        "conversion_rate": {
43          "base": "INR",
44          "rates": {
45            "INR": {
46              "name": "Indian Rupee",
47              "sub_unit": "Paisa",
48              "symbol": "₹",
49              "value": 1
50            }
51          },
52          "timestamp": 1712102400000
53        },
54        "currency": {
55          "currency_code": "INR",
56          "currency_name": "Indian Rupee",
57          "currency_sub_unit": "Paisa",
58          "currency_symbol": "₹"
59        },
60        "currency_symbol": "₹",
61        "custom_cart": {},
62        "custom_meta": [],
63        "device_id": null,
64        "employee_id": null,
65        "extra_meta": {},
66        "files": [],
67        "mode": "live",
68        "mongo_cart_id": 34742656,
69        "order_child_entities": [
70          "shipment",
71          "bag"
72        ],
73        "order_platform": "platform-site",
74        "order_tags": [],
75        "order_type": "HomeDelivery",
76        "ordering_store": null,
77        "payment_type": "partner",
78        "platform_user_details": {
79          "platform_user_employee_code": null,
80          "platform_user_first_name": "",
81          "platform_user_id": null,
82          "platform_user_last_name": ""
83        },
84        "sales_channel_logo": "/company/2683/applications/62692eafbdaef6a37a1bf655/application/pictures/free-logo/original/Y-jbdLeDF-Suresh-Fashion-Hub.png",
85        "seller_details": {
86          "country_code": "IN",
87          "currency": {
88            "code": "INR",
89            "name": "Indian Rupee",
90            "symbol": "Rs."
91          },
92          "timezone": "Asia/Kolkata"
93        },
94        "staff": {},
95        "transaction_data": {
96          "amount": 1025,
97          "id": "order_NuDeNS2ki7LLiE",
98          "merchant_order_id": "FY660D86CD0EF92B2804",
99          "status": "BAD_REQUEST_ERROR"
100        },
101        "usable_credit_notes": []
102      },
103      "order_id": "FY660D86CD0EF92B2804",
104      "payment": {
105        "payment_mode": {
106          "mode": "UPI"
107        },
108        "price_breakup": {
109          "delivery_charges": 75,
110          "discount": 0,
111          "order_value": 1025
112        }
113      },
114      "payment_methods": {
115        "UPI": {
116          "amount": 1025,
117          "collect_by": "seller",
118          "meta": {
119            "aggregator": "Razorpay",
120            "id": "order_NuDeNS2ki7LLiE",
121            "logo_url": {
122              "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/RlegqhCD_-upi_150x100.png",
123              "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/AXPZr4jPW-upi_100x78.png"
124            },
125            "merchant_code": "UPI",
126            "order_id": "FY660D86CD0EF92B2804",
127            "payment_gateway": "Razorpay",
128            "payment_id": null,
129            "payment_identifier": "test@ybl",
130            "transaction_id": null,
131            "transaction_timestamp": null
132          },
133          "mode": "UPI",
134          "name": "UPI",
135          "prices": {
136            "amount": {
137              "amount": [
138                {
139                  "currency_code": "INR",
140                  "value": 1025
141                }
142              ],
143              "is_refundable": true,
144              "taxable_amount": [
145                {
146                  "currency_code": "INR",
147                  "value": 1025
148                }
149              ],
150              "taxes": []
151            }
152          },
153          "refund_by": "seller"
154        }
155      },
156      "shipments": [
157        {
158          "bags": [
159            {
160              "affiliate_meta": {
161                "box_type": null,
162                "channel_order_id": null,
163                "channel_shipment_id": null,
164                "coupon_code": null,
165                "due_date": null,
166                "employee_discount": 0,
167                "fynd": {
168                  "fulfilment_identifier": "pulse",
169                  "fulfilment_identifiers_list": [
170                    "pulse"
171                  ]
172                },
173                "is_priority": false,
174                "loyalty_discount": 0,
175                "size_level_total_qty": 1
176              },
177              "article_json": {
178                "_id": "64b9336424cc5ee5326eb0b5",
179                "article_code": "",
180                "article_data_population_from_ACF": "current",
181                "article_history_ACF": [
182                  {
183                    "_id": "64b9336424cc5ee5326eb0b5",
184                    "last_updated_at_ACF": "2024-04-02 11:39:43.293832",
185                    "store_id": 15236
186                  }
187                ],
188                "article_type_ACF": "individual",
189                "available_article_count": 6,
190                "brand_id": 4081,
191                "cancellation_allowed": true,
192                "child_details": {},
193                "company_id": 2683,
194                "currency": {
195                  "code": "INR",
196                  "rate": 1
197                },
198                "dimension": {
199                  "height": 4,
200                  "is_default": true,
201                  "length": 24,
202                  "unit": "cm",
203                  "width": 20
204                },
205                "discount_percentage": 29.629629629629623,
206                "esp_modified": false,
207                "expiration_date": "9998-01-30 23:59:00",
208                "fragile": false,
209                "group_id": "",
210                "hsn_code": "58063200",
211                "hsn_code_id": "627783795e4c6fdbc8be3e38",
212                "identifier": {
213                  "sku_code": "17620(1)"
214                },
215                "is_gift": false,
216                "is_set": false,
217                "item_id": 9497845,
218                "last_updated_at_ACF": "2024-04-02 11:39:43.293805",
219                "manufacturing_time": 0,
220                "manufacturing_time_unit": "hours",
221                "mto_quantity": 0,
222                "price_effective": 950,
223                "price_marked": 1350,
224                "quantity": 1,
225                "return_allowed": false,
226                "return_config": {
227                  "returnable": false,
228                  "time": 0,
229                  "unit": "days"
230                },
231                "seller_identifier": "17620(1)",
232                "set": {},
233                "set_quantity": 1,
234                "size": "PACK OF 9  METERS",
235                "source_ACF": "MegatronCart",
236                "store_id": 15236,
237                "transfer_price": 0,
238                "weight": {
239                  "is_default": true,
240                  "shipping": 0.56,
241                  "unit": "gram"
242                }
243              },
244              "brand_calculated_amount": 950,
245              "discount": 400,
246              "item": {
247                "attributes": {
248                  "brand_name": "Suresh Fashion Hub India.",
249                  "essential": "No",
250                  "gender": [
251                    "Unisex"
252                  ],
253                  "marketer-address": "test address",
254                  "marketer-name": "Suresh Fashion Hub India",
255                  "media": [],
256                  "name": "Light Orange Magnolia Designer Trim",
257                  "net-quantity": "1 N",
258                  "primary-colour-hex-code": "EB8D1D",
259                  "primary_color": "Orange",
260                  "primary_color_hex": "EB8D1D"
261                },
262                "branch_url": null,
263                "brand": "Suresh Fashion Hub India.",
264                "brand_id": 4081,
265                "can_cancel": true,
266                "can_return": true,
267                "code": "17620(1)",
268                "color": null,
269                "gender": null,
270                "id": 9497845,
271                "images": [
272                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/1O-Hyh-Qc-Light-Orange-Magnolia-Designer-Trim.jpeg",
273                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/GFnSA3Xq_-Light-Orange-Magnolia-Designer-Trim.jpeg",
274                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/9x4Hl5plj-Light-Orange-Magnolia-Designer-Trim.jpeg"
275                ],
276                "l1_category": [
277                  "Accessories"
278                ],
279                "l1_category_id": 31,
280                "l2_category": [
281                  "Designer Accessories"
282                ],
283                "l2_category_id": 3320,
284                "l3_category": 3321,
285                "l3_category_name": "Designer Laces",
286                "last_updated_at": "2024-04-03T22:11:51+00:00",
287                "meta": {
288                  "departments": [
289                    21
290                  ],
291                  "tags": []
292                },
293                "name": "Light Orange Magnolia Designer Trim",
294                "slug_key": "light-orange-magnolia-designer-trim-9497845",
295                "webstore_product_url": null
296              },
297              "quantity": 1,
298              "store": {
299                "code": "HS-737a8"
300              }
301            }
302          ],
303          "billing_address_json": {
304            "address": ", test",
305            "address1": "test address",
306            "address2": "",
307            "address_category": "",
308            "address_type": "Home",
309            "area": "",
310            "area_code": "110085",
311            "area_code_slug": "pincode",
312            "city": "North Delhi",
313            "contact_person": "test test",
314            "country": "India",
315            "country_code": "+91",
316            "country_iso_code": "IN",
317            "country_phone_code": "+91",
318            "created_at": "2024-04-03 22:11:51",
319            "delivery_address_id": 5787609,
320            "display_address": " 110085\nIndia",
321            "email": "test@example.com",
322            "geo_location": {
323              "latitude": 28.7153451,
324              "longitude": 77.1088008
325            },
326            "id": "660d864e0e96a5f038a2a602",
327            "landmark": "",
328            "latitude": 28.7153451,
329            "longitude": 77.1088008,
330            "name": "test",
331            "phone": "1111111111",
332            "pincode": "110085",
333            "sector": "",
334            "state": "Delhi",
335            "state_code": "",
336            "uid": 5787609,
337            "updated_at": "2024-04-03 22:11:51",
338            "user_id": null,
339            "version": "1.0"
340          },
341          "delivery_address_json": {
342            "address": ", test addresss",
343            "address1": ", test address",
344            "address2": "",
345            "address_category": "",
346            "address_type": "Home",
347            "area": "",
348            "area_code": "110085",
349            "area_code_slug": "pincode",
350            "city": "North Delhi",
351            "contact_person": "test test",
352            "country": "India",
353            "country_code": "+91",
354            "country_iso_code": "IN",
355            "country_phone_code": "+91",
356            "created_at": "2024-04-03 22:11:51",
357            "delivery_address_id": 5787609,
358            "display_address": "Sector 11, Rohini\nNorth Delhi Delhi 110085\nIndia",
359            "email": "test@example.com",
360            "geo_location": {
361              "latitude": 28.7153451,
362              "longitude": 77.1088008
363            },
364            "id": "660d864e0e96a5f038a2a602",
365            "landmark": "",
366            "latitude": 28.7153451,
367            "longitude": 77.1088008,
368            "name": "Yashita Aggarwal",
369            "phone": "1111111111",
370            "pincode": "110085",
371            "sector": "",
372            "state": "Delhi",
373            "state_code": "",
374            "uid": 5787609,
375            "updated_at": "2024-04-03 22:11:51",
376            "user_id": null,
377            "version": "1.0"
378          },
379          "id": "17121625110871139641"
380        }
381      ],
382      "status": "payment_failed",
383      "user": {
384        "is_anonymous_user": true
385      }
386    }
387  }
388}

« offer/create/v1

payment/complete/v1 »