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