1 line
23 KiB
JSON
1 line
23 KiB
JSON
{"asyncapi":"1.0.0","info":{"title":"ec-all-events","version":"v1","description":"EC Events v1"},"topics":{"customer.created.v1":{"subscribe":{"summary":"Customer Register Event v2","payload":{"type":"object","required":["storeUid","customerId","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email of a Customer","title":"Customer uid"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"Unique id of a Store","title":"StoreUid"},"customerId":{"type":"string","required":null,"example":"0ed118f9474e","properties":null,"description":"Unique id of a Customer","title":"Customer uid"}}}}},"quote.orderplaced.v1":{"subscribe":{"summary":"Order Placed for Quote Event v1","payload":{"type":"object","required":["quoteCode","orderCode"],"properties":{"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"quote.expiresoonevent.v1":{"subscribe":{"summary":"Quote Expiring Soon Event v1","payload":{"type":"object","required":["quoteCode","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"}}}}},"password.forgotten.v1":{"subscribe":{"summary":"Forgotten Password Event v1","payload":{"type":"object","required":["storeUid","customerUid","customerId"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email of a Customer","title":"Customer uid"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"Unique id of a Store","title":"StoreUid"},"customerId":{"type":"string","required":null,"example":"0ed118f9474e","properties":null,"description":"Unique id of a Customer","title":"Customer uid"}}}}},"order.fraudemployeenotified.v1":{"subscribe":{"summary":"Order Fraud Employee Notified v1","payload":{"type":"object","required":["orderCode"],"properties":{"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.completed.v1":{"subscribe":{"summary":"Order Completed Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"quote.buyersubmit.v1":{"subscribe":{"summary":"Buyer Submitted Quote Event v1","payload":{"type":"object","required":["quoteCode","quoteUserUid","quoteUserType","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"},"quoteUserUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"ID Of User Canceling Quote","title":"ID Of User"},"quoteUserType":{"type":"string","required":null,"example":"BUYER","properties":null,"description":"User Type","title":"User Type"}}}}},"order.createreturn.v1":{"subscribe":{"summary":"Order Return Created Event v1","payload":{"type":"object","required":["orderCode","status"],"properties":{"orderCode":{"type":"string","required":null,"example":"45345345344","properties":null,"description":"Order Code of the Return Request","title":"Order Code of the Return Request"},"status":{"type":"string","required":null,"example":"RECEIVING","properties":null,"description":"Status of the Return Request","title":"Status of the Return Request"}}}}},"order.partiallyrefunded.v1":{"subscribe":{"summary":"Order Partially Refunded Event v1","payload":{"type":"object","required":["modificationCode","modificationStatus","orderCode"],"properties":{"modificationStatus":{"type":"string","required":null,"example":"SUCCESSFULL","properties":null,"description":"Status of Order Modification","title":"Status of Order Modification"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"modificationCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of the Order Modification Entry","title":"Code of the Order Modification Entry"}}}}},"quote.sellerapproved.v1":{"subscribe":{"summary":"Seller Approved Quote Event v1","payload":{"type":"object","required":["quoteCode","quoteUserUid","quoteUserType","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"},"quoteUserUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"ID Of User Canceling Quote","title":"ID Of User"},"quoteUserType":{"type":"string","required":null,"example":"BUYER","properties":null,"description":"User Type","title":"User Type"}}}}},"cronjob.finished.v1":{"subscribe":{"summary":"CronJob Finished Event v1","payload":{"type":"object","required":["cronJobCode","jobCode","jobType","cronJobType","result","status"],"properties":{"result":{"type":"string","required":null,"example":"CatalogVersionSyncCronJob","properties":null,"description":"Result of CronJob Execution","title":"Result of CronJob Execution"},"cronJobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"CronJob Code","title":"CronJob Code"},"jobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"Job Code","title":"Job Code"},"jobType":{"type":"string","required":null,"example":"CatalogVersionSyncJob","properties":null,"description":"Job Type","title":"Job Type"},"cronJobType":{"type":"string","required":null,"example":"CatalogVersionSyncCronJob","properties":null,"description":"Job Type","title":"CronJob Type"},"status":{"type":"string","required":null,"example":"CatalogVersionSyncCronJob","properties":null,"description":"Status of CronJob Execution","title":"Status of CronJob Execution"}}}}},"order.cancelpending.v1":{"subscribe":{"summary":"Order Pending Cancellation Event v1","payload":{"type":"object","required":["cancelRequestCode","orderCode"],"properties":{"cancelRequestCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of the Cancel Request Record Entry","title":"Code of the Cancel Request Record Entry"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"cronjob.dataexport.v1":{"subscribe":{"summary":"Data Export CronJob Started/Ended Event v1","payload":{"type":"object","required":["exportCode"],"properties":{"exportCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"Code of Export CronJob","title":"Code of Export CronJob"}}}}},"order.processing.v1":{"subscribe":{"summary":"Order Processing Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"cart.fileupload.v1":{"subscribe":{"summary":"Cart File Upload Received Event v1","payload":{"type":"object","required":["mediaCode","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer.","title":"Customer uid"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Stored ID"},"mediaCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"Code of Upload File (Media)","title":"Code of Media File"}}}}},"order.readyforpickup.v1":{"subscribe":{"summary":"Send Ready for Instore Pickuo Message Event v1","payload":{"type":"object","required":["consignmentCode","orderCode"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"customer.changeuid.v1":{"subscribe":{"summary":"Customer Changed Email Address Event v1","payload":{"type":"object","required":["storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer.","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Stored ID"}}}}},"order.placed.v1":{"subscribe":{"summary":"Order Placed Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.fraud.v1":{"subscribe":{"summary":"Order Fraud Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"system.tenantrestart.v1":{"subscribe":{"summary":"Tenant Restarted Event v1","payload":{"type":"object","required":["timestamp","tenantId"],"properties":{"tenantId":{"type":"string","required":null,"example":"master","properties":null,"description":"ID of Tenant that has been Restarted","title":"ID of Tenant that has been Restarted"},"timestamp":{"type":"string","required":null,"example":"45345345344","properties":null,"description":"Timestamp of Initialization Start","title":"Timestamp of Initialization Start"}}}}},"cronjob.beforestart.v1":{"subscribe":{"summary":"Before CronJob Start Event v1","payload":{"type":"object","required":["cronJobCode","jobCode","jobType","cronJobType"],"properties":{"cronJobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"CronJob Code","title":"CronJob Code"},"jobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"Job Code","title":"Job Code"},"jobType":{"type":"string","required":null,"example":"CatalogVersionSyncJob","properties":null,"description":"Job Type","title":"Job Type"},"cronJobType":{"type":"string","required":null,"example":"CatalogVersionSyncCronJob","properties":null,"description":"Job Type","title":"CronJob Type"}}}}},"order.partiallycanceled.v1":{"subscribe":{"summary":"Order Partially Cancelled Event v1","payload":{"type":"object","required":["modificationCode","modificationStatus","orderCode"],"properties":{"modificationStatus":{"type":"string","required":null,"example":"SUCCESSFULL","properties":null,"description":"Status of Order Modification","title":"Status of Order Modification"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"modificationCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of the Order Modification Entry","title":"Code of the Order Modification Entry"}}}}},"cronjob.aborted.v1":{"subscribe":{"summary":"CronJob Aborted event v1","payload":{"type":"object","required":["cronJobCode","jobCode","jobType","cronJobType"],"properties":{"cronJobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"CronJob Code","title":"CronJob Code"},"jobCode":{"type":"string","required":null,"example":"123456","properties":null,"description":"Job Code","title":"Job Code"},"jobType":{"type":"string","required":null,"example":"CatalogVersionSyncJob","properties":null,"description":"Job Type","title":"Job Type"},"cronJobType":{"type":"string","required":null,"example":"CatalogVersionSyncCronJob","properties":null,"description":"Job Type","title":"CronJob Type"}}}}},"order.frauderror.v1":{"subscribe":{"summary":"Error during Fraud Processing Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.paymentfailed.v1":{"subscribe":{"summary":"Payment Failed for Order Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.fraudcustomernotified.v1":{"subscribe":{"summary":"Order Fraud Customer Notified Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"system.initializationend.v1":{"subscribe":{"summary":"System Initialization Complete Event v1","payload":{"type":"object","required":["timestamp"],"properties":{"timestamp":{"type":"string","required":null,"example":"45345345344","properties":null,"description":"Timestamp of Initialization Completion","title":"Timestamp of Initialization Completion"}}}}},"quote.expired.v1":{"subscribe":{"summary":"Quote Expired Event v1","payload":{"type":"object","required":["quoteCode","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"}}}}},"order.deliverysent.v1":{"subscribe":{"summary":"Order Delivery Sent Event v1","payload":{"type":"object","required":["consignmentCode","orderCode","consignmentStatus"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"consignmentStatus":{"type":"string","required":null,"example":"PICKUP_COMPLETE","properties":null,"description":"Consignment Status","title":"Consignment Status"}}}}},"quote.cancelled.v1":{"subscribe":{"summary":"Quoted Cancelled Event v1","payload":{"type":"object","required":["quoteCode","quoteUserUid","quoteUserType","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"},"quoteUserUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"ID Of User Canceling Quote","title":"ID Of User"},"quoteUserType":{"type":"string","required":null,"example":"BUYER","properties":null,"description":"User Type","title":"User Type"}}}}},"order.refund.v1":{"subscribe":{"summary":"Order Refund Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"consigment.consignmentprocessing.v1":{"subscribe":{"summary":"Consignment Processing Event v1","payload":{"type":"object","required":["consignmentCode","orderCode","consignmentStatus"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"consignmentStatus":{"type":"string","required":null,"example":"PICKUP_COMPLETE","properties":null,"description":"Consignment Status","title":"Consignment Status"}}}}},"quote.salesrepsubmit.v1":{"subscribe":{"summary":"Sales Rep Submitted Quote Event v1","payload":{"type":"object","required":["quoteCode","quoteUserUid","quoteUserType","storeUid","customerUid"],"properties":{"customerUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"Email Address of Customer","title":"Customer ID"},"storeUid":{"type":"string","required":null,"example":"4caad296","properties":null,"description":"ID of the Store (BaseStore)","title":"Store ID"},"quoteCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Quote","title":"Quote Code"},"quoteUserUid":{"type":"string","required":null,"example":"adam@hybris.com","properties":null,"description":"ID Of User Canceling Quote","title":"ID Of User"},"quoteUserType":{"type":"string","required":null,"example":"BUYER","properties":null,"description":"User Type","title":"User Type"}}}}},"order.pickedup.v1":{"subscribe":{"summary":"Send Picked up Message Instore Event v1","payload":{"type":"object","required":["consignmentCode","orderCode","consignmentStatus"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"consignmentStatus":{"type":"string","required":null,"example":"PICKUP_COMPLETE","properties":null,"description":"Consignment Status","title":"Consignment Status"}}}}},"order.cancelled.v1":{"subscribe":{"summary":"Order Cancelled Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.pickupconfirmation.v1":{"subscribe":{"summary":"Order Picked Up in Store Event v1","payload":{"type":"object","required":["consignmentCode","orderCode","consignmentStatus"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"consignmentStatus":{"type":"string","required":null,"example":"PICKUP_COMPLETE","properties":null,"description":"Consignment Status","title":"Consignment Status"}}}}},"order.notpickedcancelconsignment.v1":{"subscribe":{"summary":"Order Items Not Picked and Cancelled Event v1","payload":{"type":"object","required":["consignmentCode","orderCode","consignmentStatus"],"properties":{"consignmentCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Consignment","title":"Consignment Code"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"},"consignmentStatus":{"type":"string","required":null,"example":"PICKUP_COMPLETE","properties":null,"description":"Consignment Status","title":"Consignment Status"}}}}},"order.paymentauthfailed.v1":{"subscribe":{"summary":"Payment Authorization Failed for Order Event v1","payload":{"type":"object","required":["orderCode","orderStatus"],"properties":{"orderStatus":{"type":"string","required":null,"example":"CHECKED_INVALID","properties":null,"description":"Status of Order","title":"Order Status"},"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of Order","title":"Order Code"}}}}},"order.created.v1":{"subscribe":{"summary":"Submit Order Event","payload":{"type":"object","properties":{"orderCode":{"type":"string","required":null,"example":"76272727","properties":null,"description":"Code of an Order","title":"Order code"}}}}},"system.initializationstart.v1":{"subscribe":{"summary":"System Initialization Started Event v1","payload":{"type":"object","required":["timestamp"],"properties":{"timestamp":{"type":"string","required":null,"example":"45345345344","properties":null,"description":"Timestamp of Initialization Start","title":"Timestamp of Initialization Start"}}}}}}} |