docs: generate references after adding copy subscriber button (#12407)
* docs: generate references after adding copy subscriber button * re-generate
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
7ef13495d6
commit
41f46b7723
113 files changed
+325290
-318981
No files matched your search
@@ -247,7 +247,7 @@ export const generatedEditDates = {
|
||||
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.listAuthIdentities/page.mdx": "2025-04-11T09:04:43.744Z",
|
||||
"references/auth/interfaces/auth.FilterableAuthIdentityProps/page.mdx": "2024-12-23T13:57:04.094Z",
|
||||
"references/auth/interfaces/auth.IAuthModuleService/page.mdx": "2024-11-25T17:49:28.823Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx": "2025-05-01T15:18:36.623Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx": "2025-05-08T07:20:05.576Z",
|
||||
"references/core_flows/Cart/core_flows.Cart.Workflows_Cart/page.mdx": "2025-03-04T13:33:40.472Z",
|
||||
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.createRemoteLinkStep/page.mdx": "2025-04-11T09:04:35.926Z",
|
||||
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.dismissRemoteLinkStep/page.mdx": "2025-04-11T09:04:35.929Z",
|
||||
@@ -286,19 +286,19 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelClaimValidateOrderStep/page.mdx": "2025-04-23T16:21:19.440Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelExchangeValidateOrder/page.mdx": "2025-04-23T16:21:19.885Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentValidateOrder/page.mdx": "2025-04-11T09:04:37.319Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx": "2025-05-01T15:18:37.676Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx": "2025-05-08T07:20:06.643Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReceiveReturnValidationStep/page.mdx": "2025-04-11T09:04:39.395Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelRequestReturnValidationStep/page.mdx": "2025-04-11T09:04:39.419Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestValidationStep/page.mdx": "2025-04-11T09:04:37.588Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx": "2025-05-01T15:18:37.830Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx": "2025-05-08T07:20:06.813Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestValidationStep/page.mdx": "2025-04-11T09:04:38.284Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx": "2025-05-01T15:18:38.207Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx": "2025-05-08T07:20:07.253Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestValidationStep/page.mdx": "2025-04-11T09:04:38.808Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx": "2025-05-01T15:18:38.482Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx": "2025-05-08T07:20:07.521Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReceiveReturnValidationStep/page.mdx": "2025-04-11T09:04:39.455Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx": "2025-05-01T15:18:38.783Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx": "2025-05-08T07:20:07.871Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestValidationStep/page.mdx": "2025-04-11T09:04:39.503Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx": "2025-05-01T15:18:38.810Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx": "2025-05-08T07:20:07.899Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodValidationStep/page.mdx": "2025-04-11T09:04:37.638Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx": "2025-05-07T15:35:10.141Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodValidationStep/page.mdx": "2025-04-11T09:04:38.334Z",
|
||||
@@ -353,7 +353,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnValidationStep/page.mdx": "2025-04-11T09:04:39.866Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnWorkflow/page.mdx": "2025-05-07T15:35:11.270Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestValidationStep/page.mdx": "2025-04-11T09:04:39.127Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx": "2025-05-01T15:18:38.617Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx": "2025-05-08T07:20:07.658Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemValidationStep/page.mdx": "2025-04-11T09:04:37.834Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemWorkflow/page.mdx": "2025-05-07T15:35:10.236Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimItemValidationStep/page.mdx": "2025-04-11T09:04:37.917Z",
|
||||
@@ -726,33 +726,33 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx": "2025-04-11T09:04:35.692Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx": "2025-04-11T09:04:35.832Z",
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx": "2025-04-11T09:04:35.983Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx": "2025-05-01T15:18:36.756Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx": "2025-05-01T15:18:36.759Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx": "2025-05-01T15:18:36.764Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx": "2025-05-01T15:18:36.779Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx": "2025-05-08T07:20:05.703Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx": "2025-05-08T07:20:05.706Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx": "2025-05-08T07:20:05.711Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx": "2025-05-08T07:20:05.726Z",
|
||||
"references/core_flows/Customer/core_flows.Customer.Steps_Customer/page.mdx": "2024-12-23T12:30:23.718Z",
|
||||
"references/core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx": "2024-12-23T12:30:23.763Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx": "2025-05-01T15:18:37.339Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx": "2025-05-01T15:18:37.342Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx": "2025-05-01T15:18:37.344Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx": "2025-05-08T07:20:06.283Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx": "2025-05-08T07:20:06.286Z",
|
||||
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx": "2025-05-08T07:20:06.288Z",
|
||||
"references/core_flows/Invite/core_flows.Invite.Workflows_Invite/page.mdx": "2024-12-23T12:30:24.034Z",
|
||||
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.listLineItemsStep/page.mdx": "2025-04-11T09:04:36.677Z",
|
||||
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx": "2025-04-11T09:04:36.705Z",
|
||||
"references/core_flows/Line_Item/core_flows.Line_Item.Steps_Line_Item/page.mdx": "2024-12-23T12:30:24.048Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx": "2025-05-01T15:18:39.692Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx": "2025-05-08T07:20:08.726Z",
|
||||
"references/core_flows/Product/core_flows.Product.Workflows_Product/page.mdx": "2025-01-13T17:30:25.740Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.createRegionsWorkflow/page.mdx": "2025-05-01T15:18:39.788Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.deleteRegionsWorkflow/page.mdx": "2025-05-01T15:18:39.790Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.updateRegionsWorkflow/page.mdx": "2025-05-01T15:18:39.794Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.createRegionsWorkflow/page.mdx": "2025-05-08T07:20:08.823Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.deleteRegionsWorkflow/page.mdx": "2025-05-08T07:20:08.826Z",
|
||||
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.updateRegionsWorkflow/page.mdx": "2025-05-08T07:20:08.830Z",
|
||||
"references/core_flows/Region/core_flows.Region.Workflows_Region/page.mdx": "2024-12-23T12:30:26.377Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.createSalesChannelsWorkflow/page.mdx": "2025-05-01T15:18:39.863Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.deleteSalesChannelsWorkflow/page.mdx": "2025-05-01T15:18:39.865Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.updateSalesChannelsWorkflow/page.mdx": "2025-05-01T15:18:39.868Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.createSalesChannelsWorkflow/page.mdx": "2025-05-08T07:20:08.887Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.deleteSalesChannelsWorkflow/page.mdx": "2025-05-08T07:20:08.890Z",
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.updateSalesChannelsWorkflow/page.mdx": "2025-05-08T07:20:08.892Z",
|
||||
"references/core_flows/Sales_Channel/core_flows.Sales_Channel.Workflows_Sales_Channel/page.mdx": "2024-12-23T12:30:26.435Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUserAccountWorkflow/page.mdx": "2025-05-01T15:18:39.988Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUsersWorkflow/page.mdx": "2025-05-01T15:18:39.990Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.deleteUsersWorkflow/page.mdx": "2025-05-01T15:18:39.992Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.updateUsersWorkflow/page.mdx": "2025-05-01T15:18:39.997Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUserAccountWorkflow/page.mdx": "2025-05-08T07:20:09.009Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUsersWorkflow/page.mdx": "2025-05-08T07:20:09.011Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.deleteUsersWorkflow/page.mdx": "2025-05-08T07:20:09.013Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.updateUsersWorkflow/page.mdx": "2025-05-08T07:20:09.018Z",
|
||||
"references/core_flows/User/core_flows.User.Workflows_User/page.mdx": "2024-12-23T12:30:26.574Z",
|
||||
"references/core_flows/core_flows.Steps_Customer/page.mdx": "2024-12-09T13:21:38.061Z",
|
||||
"references/core_flows/core_flows.Steps_Line_Item/page.mdx": "2024-12-09T13:21:39.005Z",
|
||||
@@ -794,7 +794,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.completeOrdersStep/page.mdx": "2025-04-11T09:04:36.903Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx": "2025-04-11T09:04:36.982Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.setOrderTaxLinesForItemsStep/page.mdx": "2025-04-11T09:04:37.167Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx": "2025-05-01T15:18:37.664Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx": "2025-05-08T07:20:06.631Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderValidationStep/page.mdx": "2025-04-11T09:04:37.351Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditValidationStep/page.mdx": "2025-04-11T09:04:38.746Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderExchangeValidationStep/page.mdx": "2025-04-11T09:04:38.205Z",
|
||||
@@ -802,7 +802,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReturnOrderValidationStep/page.mdx": "2025-04-11T09:04:39.347Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnValidateOrder/page.mdx": "2025-04-11T09:04:39.429Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelValidateOrder/page.mdx": "2025-04-11T09:04:37.336Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx": "2025-05-01T15:18:38.012Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx": "2025-05-08T07:20:07.014Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createFulfillmentValidateOrder/page.mdx": "2025-04-11T09:04:38.038Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createShipmentValidateOrder/page.mdx": "2025-05-07T15:35:10.414Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx": "2025-05-07T15:35:11.535Z",
|
||||
@@ -885,7 +885,7 @@ export const generatedEditDates = {
|
||||
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.updateAuthIdentities/page.mdx": "2025-04-11T09:04:43.757Z",
|
||||
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.updateProvider/page.mdx": "2024-12-09T13:21:36.245Z",
|
||||
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.updateProviderIdentities/page.mdx": "2025-04-11T09:04:43.777Z",
|
||||
"references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx": "2025-05-01T15:18:36.450Z",
|
||||
"references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx": "2025-05-08T07:20:05.415Z",
|
||||
"references/core_flows/Auth/core_flows.Auth.Workflows_Auth/page.mdx": "2024-12-23T12:30:23.507Z",
|
||||
"references/core_flows/core_flows.Workflows_Auth/page.mdx": "2024-12-09T13:21:37.265Z",
|
||||
"references/types/CommonTypes/types/types.CommonTypes.TransformObjectMethodToAsync/page.mdx": "2024-12-23T12:30:28.073Z",
|
||||
@@ -957,9 +957,9 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx": "2025-05-07T15:35:09.560Z",
|
||||
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.validateFulfillmentDeliverabilityStep/page.mdx": "2025-01-20T08:25:20.588Z",
|
||||
"references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.validateInventoryLevelsDelete/page.mdx": "2025-01-20T08:25:20.641Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx": "2025-05-01T15:18:38.424Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx": "2025-05-08T07:20:07.461Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderFulfillmentDeliverablilityValidationStep/page.mdx": "2025-04-11T09:04:38.713Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.removeUserAccountWorkflow/page.mdx": "2025-05-01T15:18:39.994Z",
|
||||
"references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.removeUserAccountWorkflow/page.mdx": "2025-05-08T07:20:09.016Z",
|
||||
"references/core_flows/types/core_flows.RemoveCustomerAccountWorkflowInput/page.mdx": "2024-12-09T13:21:50.344Z",
|
||||
"references/core_flows/types/core_flows.RemoveUserAccountWorkflowInput/page.mdx": "2024-12-09T13:21:55.016Z",
|
||||
"references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.createCustomerAddresses/page.mdx": "2025-04-11T09:04:44.667Z",
|
||||
@@ -1071,24 +1071,24 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderLineItemsStep/page.mdx": "2025-04-23T16:21:19.201Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-05-07T15:35:09.876Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx": "2025-05-01T15:18:37.648Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx": "2025-05-01T15:18:37.684Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-05-01T15:18:39.550Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx": "2025-05-01T15:18:39.558Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx": "2025-05-01T15:18:39.562Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx": "2025-05-01T15:18:39.565Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx": "2025-05-01T15:18:39.571Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx": "2025-05-01T15:18:39.579Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx": "2025-05-01T15:18:39.582Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx": "2025-05-01T15:18:39.584Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx": "2025-05-01T15:18:39.589Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx": "2025-05-01T15:18:39.587Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx": "2025-05-01T15:18:39.591Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx": "2025-05-01T15:18:39.593Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx": "2025-05-01T15:18:39.598Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx": "2025-05-01T15:18:39.602Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx": "2025-05-01T15:18:39.609Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx": "2025-05-01T15:18:39.605Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx": "2025-05-01T15:18:39.667Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx": "2025-05-08T07:20:06.651Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-05-08T07:20:08.649Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx": "2025-05-08T07:20:08.653Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx": "2025-05-08T07:20:08.658Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx": "2025-05-08T07:20:08.661Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx": "2025-05-08T07:20:08.666Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx": "2025-05-08T07:20:08.675Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx": "2025-05-08T07:20:08.677Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx": "2025-05-08T07:20:08.679Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx": "2025-05-08T07:20:08.684Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx": "2025-05-08T07:20:08.682Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx": "2025-05-08T07:20:08.686Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx": "2025-05-08T07:20:08.688Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx": "2025-05-08T07:20:08.693Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx": "2025-05-08T07:20:08.698Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx": "2025-05-08T07:20:08.704Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx": "2025-05-08T07:20:08.701Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx": "2025-05-08T07:20:08.711Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx": "2025-05-01T15:18:39.751Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx": "2025-05-01T15:18:39.758Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx": "2025-05-01T15:18:39.760Z",
|
||||
@@ -1892,9 +1892,9 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.createProductCategoriesStep/page.mdx": "2025-04-11T09:04:41.068Z",
|
||||
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.deleteProductCategoriesStep/page.mdx": "2025-01-13T17:30:25.836Z",
|
||||
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.updateProductCategoriesStep/page.mdx": "2025-04-11T09:04:41.084Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.createProductCategoriesWorkflow/page.mdx": "2025-05-01T15:18:39.714Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.deleteProductCategoriesWorkflow/page.mdx": "2025-05-01T15:18:39.717Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.updateProductCategoriesWorkflow/page.mdx": "2025-05-01T15:18:39.723Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.createProductCategoriesWorkflow/page.mdx": "2025-05-08T07:20:08.749Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.deleteProductCategoriesWorkflow/page.mdx": "2025-05-08T07:20:08.751Z",
|
||||
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.updateProductCategoriesWorkflow/page.mdx": "2025-05-08T07:20:08.757Z",
|
||||
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.addCampaignPromotionsStep/page.mdx": "2025-02-11T11:36:44.164Z",
|
||||
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.createCampaignsStep/page.mdx": "2025-04-11T09:04:41.127Z",
|
||||
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.createPromotionsStep/page.mdx": "2025-04-11T09:04:41.132Z",
|
||||
@@ -2120,7 +2120,7 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/order/order-change/page.mdx": "2024-10-09T09:59:40.745Z",
|
||||
"app/commerce-modules/payment/links-to-other-modules/page.mdx": "2025-04-17T15:53:23.515Z",
|
||||
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx": "2025-04-11T09:04:35.943Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx": "2025-05-01T15:18:39.311Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx": "2025-05-08T07:20:08.422Z",
|
||||
"references/helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx": "2025-01-17T16:43:22.242Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.undoLastChange/page.mdx": "2025-04-11T09:04:50.317Z",
|
||||
"references/order/interfaces/order.CreateOrderLineItemAdjustmentDTO/page.mdx": "2024-12-09T13:22:01.264Z",
|
||||
@@ -2161,7 +2161,7 @@ export const generatedEditDates = {
|
||||
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx": "2024-12-09T13:21:35.373Z",
|
||||
"references/user/interfaces/user.FindConfig/page.mdx": "2025-02-11T11:36:54.693Z",
|
||||
"references/workflows/types/workflows.StepFunction/page.mdx": "2025-04-23T07:49:56.555Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx": "2025-05-01T15:18:36.614Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx": "2025-05-08T07:20:05.568Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx": "2025-01-17T16:43:27.199Z",
|
||||
"references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx": "2024-12-17T16:57:25.097Z",
|
||||
"references/types/CommonTypes/interfaces/types.CommonTypes.RequestQueryFields/page.mdx": "2024-12-09T13:21:32.865Z",
|
||||
@@ -3383,9 +3383,9 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderTransferRequestWorkflow/page.mdx": "2025-05-07T15:35:11.408Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineTransferOrderRequestValidationStep/page.mdx": "2025-04-11T09:04:40.292Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferValidationStep/page.mdx": "2025-04-11T09:04:40.179Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx": "2025-05-01T15:18:39.159Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx": "2025-05-08T07:20:08.327Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderValidationStep/page.mdx": "2025-04-11T09:04:40.310Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx": "2025-05-01T15:18:39.205Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx": "2025-05-08T07:20:08.373Z",
|
||||
"references/core_flows/Sales_Channel/Steps_Sales_Channel/functions/core_flows.Sales_Channel.Steps_Sales_Channel.canDeleteSalesChannelsOrThrowStep/page.mdx": "2025-01-13T18:05:52.393Z",
|
||||
"references/core_flows/Steps_Api_Key/functions/core_flows.Steps_Api_Key.createApiKeysStep/page.mdx": "2024-12-09T13:21:37.225Z",
|
||||
"references/core_flows/Steps_Api_Key/functions/core_flows.Steps_Api_Key.deleteApiKeysStep/page.mdx": "2024-12-09T13:21:37.225Z",
|
||||
|
||||
@@ -9927,6 +9927,110 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/event/interfaces/event.IEventBusModuleService/page.mdx",
|
||||
"pathname": "/references/event/interfaces/event.IEventBusModuleService"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Auth/variables/events.Auth.AuthWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Auth/variables/events.Auth.AuthWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Cart/variables/events.Cart.CartWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Cart/variables/events.Cart.CartWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Customer/variables/events.Customer.CustomerWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Customer/variables/events.Customer.CustomerWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Fulfillment/variables/events.Fulfillment.FulfillmentWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Fulfillment/variables/events.Fulfillment.FulfillmentWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Order/variables/events.Order.OrderEditWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Order/variables/events.Order.OrderEditWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Order/variables/events.Order.OrderWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Order/variables/events.Order.OrderWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductCategoryWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductCategoryWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductCollectionWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductCollectionWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductOptionWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductOptionWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductTagWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductTagWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductTypeWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductTypeWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductVariantWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductVariantWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Product/variables/events.Product.ProductWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Product/variables/events.Product.ProductWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Region/variables/events.Region.RegionWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Region/variables/events.Region.RegionWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/Sales_Channel/variables/events.Sales_Channel.SalesChannelWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/Sales_Channel/variables/events.Sales_Channel.SalesChannelWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/User/variables/events.User.InviteWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/User/variables/events.User.InviteWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/User/variables/events.User.UserWorkflowEvents/page.mdx",
|
||||
"pathname": "/references/events/User/variables/events.User.UserWorkflowEvents"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Auth/page.mdx",
|
||||
"pathname": "/references/events/events.Auth"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Cart/page.mdx",
|
||||
"pathname": "/references/events/events.Cart"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Customer/page.mdx",
|
||||
"pathname": "/references/events/events.Customer"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Fulfillment/page.mdx",
|
||||
"pathname": "/references/events/events.Fulfillment"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Order/page.mdx",
|
||||
"pathname": "/references/events/events.Order"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Product/page.mdx",
|
||||
"pathname": "/references/events/events.Product"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Region/page.mdx",
|
||||
"pathname": "/references/events/events.Region"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.Sales_Channel/page.mdx",
|
||||
"pathname": "/references/events/events.Sales_Channel"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/events/events.User/page.mdx",
|
||||
"pathname": "/references/events/events.User"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx",
|
||||
"pathname": "/references/file/classes/file.AbstractFileProviderService"
|
||||
|
||||
+15
@@ -175,6 +175,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -195,6 +198,18 @@ to send a reset password email to the user or customer, for example.
|
||||
token, // The generated token.
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "auth.password_reset",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
entity_id, // The identifier of the user or customer. For example, an email address.
|
||||
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
||||
token, // The generated token.
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -227,6 +227,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -244,6 +247,16 @@ Emitted when a cart's details are updated.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -284,6 +284,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -301,6 +304,16 @@ Emitted when a cart's details are updated.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -193,6 +193,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -211,6 +214,16 @@ order.
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.placed",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -306,6 +306,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -323,6 +326,16 @@ Emitted when a cart is created.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+33
@@ -273,6 +273,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -290,6 +293,16 @@ Emitted when a cart's details are updated.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -305,6 +318,16 @@ Emitted when the customer in the cart is updated.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.customer_updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -321,6 +344,16 @@ event is emitted alongside the `cart.updated` event.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.region_updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -259,6 +259,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -276,6 +279,16 @@ Emitted when a cart's details are updated.
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "cart.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -180,6 +180,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -197,6 +200,16 @@ Emitted when a customer is created.
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "customer.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -212,6 +212,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -229,6 +232,16 @@ Emitted when a customer is created.
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "customer.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -188,6 +188,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -205,6 +208,16 @@ Emitted when a customer is deleted.
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "customer.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -165,6 +165,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -182,6 +185,16 @@ Emitted when a customer is deleted.
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "customer.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -206,6 +206,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -223,6 +226,16 @@ Emitted when a customer is updated.
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "customer.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+68
-1
@@ -2,6 +2,10 @@
|
||||
slug: /references/medusa-workflows/convertDraftOrderWorkflow
|
||||
sidebar_label: convertDraftOrderWorkflow
|
||||
sidebar_description: Convert a draft order to a pending order.
|
||||
tags:
|
||||
- remote query
|
||||
- event bus
|
||||
- workflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
@@ -10,7 +14,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `convertDraftOrderWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/6f8ffcf53c709d40dfeb5980f3769cd0bb810e3e/packages/core/core-flows/src/draft-order/workflows/convert-draft-order.ts#L97" />
|
||||
This workflow converts a draft order to a pending order. It's used by the
|
||||
[Convert Draft Order to Order Admin API Route](https://docs.medusajs.com/api/admin#draft-orders\_postdraftordersidconverttoorder).
|
||||
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||
converting a draft order to a pending order.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/draft-order/workflows/convert-draft-order.ts#L97" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -117,6 +127,10 @@ const myWorkflow = createWorkflow(
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"convertDraftOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateDraftOrderStep","description":"This step validates that an order is a draft order. It throws an error otherwise.\n\n:::note\n\nYou can retrieve a draft order's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),\nor [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).\n\n:::","link":"../../../Steps_Draft_Order/functions/core_flows.Draft_Order.Steps_Draft_Order.validateDraftOrderStep/page.mdx","depth":2},{"type":"step","name":"convertDraftOrderStep","description":"This step converts a draft order to a pending order.","link":"../core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":4}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ConvertDraftOrderWorkflowInput","type":"[ConvertDraftOrderWorkflowInput](../../../../interfaces/core_flows.ConvertDraftOrderWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The details of the draft order to convert to an order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the draft order to convert to an order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="convertDraftOrderWorkflow"/>
|
||||
@@ -124,3 +138,56 @@ const myWorkflow = createWorkflow(
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderDTO","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandablLine truncated
|
||||
|
||||
## Emitted Events
|
||||
|
||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||
|
||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
`order.placed`
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order is placed, or when a draft order is converted to an
|
||||
order.
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.placed",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
+13
@@ -170,6 +170,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -188,6 +191,16 @@ doesn't include updates made by an edit.
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+23
@@ -185,6 +185,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -202,6 +205,16 @@ Emitted when users are created.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -217,6 +230,16 @@ Emitted when an invite is accepted.
|
||||
id, // The ID of the invite
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "invite.accepted",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the invite
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -164,6 +164,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -182,6 +185,16 @@ to send an email to the invited users, for example.
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "invite.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -152,6 +152,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -169,6 +172,16 @@ Emitted when invites are deleted.
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "invite.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -160,6 +160,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -179,6 +182,16 @@ for example.
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "invite.resent",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -155,6 +155,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -172,6 +175,16 @@ Emitted when an order is archived.
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.archived",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+16
-2
@@ -21,7 +21,7 @@ This workflow cancels a requested edit for an order. It's used by the
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an order edit
|
||||
in your custom flow.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/order-edit/cancel-begin-order-edit.ts#L99" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/order-edit/cancel-begin-order-edit.ts#L99" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -153,6 +153,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -168,9 +171,20 @@ Emitted when an order edit request is canceled.
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order-edit.canceled",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+17
-2
@@ -25,7 +25,7 @@ allows you to update custom data models linked to the fulfillment.
|
||||
|
||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts#L295" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts#L295" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -201,6 +201,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -217,9 +220,21 @@ Emitted when an order's fulfillment is canceled.
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.fulfillment_canceled",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -189,6 +189,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -206,6 +209,16 @@ Emitted when an order is canceld.
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.canceled",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -197,6 +197,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -214,6 +217,16 @@ Emitted when orders are completed.
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.completed",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+14
@@ -162,6 +162,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -180,6 +183,17 @@ Emitted when a claim is created for an order.
|
||||
claim_id, // The ID of the claim
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.claim_created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
claim_id, // The ID of the claim
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+14
@@ -162,6 +162,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -180,6 +183,17 @@ Emitted when an exchange is created for an order.
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.exchange_created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+16
-2
@@ -25,7 +25,7 @@ This workflow confirms an order edit request. It's used by the
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to confirm an order edit
|
||||
in your custom flow.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/order-edit/confirm-order-edit-request.ts#L113" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/order-edit/confirm-order-edit-request.ts#L113" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -161,6 +161,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -176,9 +179,20 @@ Emitted when an order edit request is confirmed.
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order-edit.confirmed",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+14
@@ -159,6 +159,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -177,6 +180,17 @@ Emitted when a return is marked as received.
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.return_received",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+14
@@ -160,6 +160,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -178,6 +181,17 @@ Emitted when a return request is confirmed.
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.return_requested",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+25
@@ -237,6 +237,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -255,6 +258,17 @@ Emitted when a return request is confirmed.
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.return_requested",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -271,6 +285,17 @@ Emitted when a return is marked as received.
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.return_received",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+17
-2
@@ -26,7 +26,7 @@ allows you to create custom data models linked to the fulfillment.
|
||||
|
||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/create-fulfillment.ts#L392" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/create-fulfillment.ts#L392" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -218,6 +218,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -234,9 +237,21 @@ Emitted when a fulfillment is created for an order.
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.fulfillment_created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // (boolean) Whether to notify the customer
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+16
-2
@@ -23,7 +23,7 @@ allows you to create custom data models linked to the shipment.
|
||||
|
||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a shipment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/create-shipment.ts#L198" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/create-shipment.ts#L198" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -215,6 +215,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -230,9 +233,20 @@ Emitted when a shipment is created for an order.
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // the ID of the shipment
|
||||
no_notification, // whether to notify the customer
|
||||
no_notification, // (boolean) whether to notify the customer
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "shipment.created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the shipment
|
||||
no_notification, // (boolean) whether to notify the customer
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -158,6 +158,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -175,6 +178,16 @@ Emitted when a fulfillment is marked as delivered.
|
||||
id, // the ID of the fulfillment
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "delivery.created",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the fulfillment
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+16
-2
@@ -21,7 +21,7 @@ the [Request Order Edit Admin API Route](https://docs.medusajs.com/api/admin#ord
|
||||
You can use this workflow within your customizations or your own custom workflows, allowing you to request an order edit
|
||||
in your custom flows.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/ecf3556589c1fb64ad8bdc0b88307b11a6f7c89f/packages/core/core-flows/src/order/workflows/order-edit/request-order-edit.ts#L125" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/196f6b7015d8349f311eea6194223af60b9e59c5/packages/core/core-flows/src/order/workflows/order-edit/request-order-edit.ts#L125" />
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -157,6 +157,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -172,9 +175,20 @@ Emitted when an order edit is requested.
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order-edit.requested",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+14
@@ -167,6 +167,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -186,6 +189,17 @@ another customer.
|
||||
order_change_id, // The ID of the order change created for the transfer
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.transfer_requested",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
order_change_id, // The ID of the order change created for the transfer
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -165,6 +165,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -183,6 +186,16 @@ doesn't include updates made by an edit.
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.updated",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -177,6 +177,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -195,6 +198,16 @@ order.
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "order.placed",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+33
@@ -221,6 +221,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -238,6 +241,16 @@ Emitted when product variants are updated.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -253,6 +266,16 @@ Emitted when product variants are created.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -268,6 +291,16 @@ Emitted when product variants are deleted.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+43
@@ -234,6 +234,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -251,6 +254,16 @@ Emitted when product variants are created.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -266,6 +279,16 @@ Emitted when products are updated.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -281,6 +304,16 @@ Emitted when products are created.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -296,6 +329,16 @@ Emitted when products are deleted.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -206,6 +206,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -223,6 +226,16 @@ Emitted when product collections are created.
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-collection.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -229,6 +229,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -246,6 +249,16 @@ Emitted when product options are created.
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-option.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -206,6 +206,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -223,6 +226,16 @@ Emitted when product tags are created.
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-tag.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -206,6 +206,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -223,6 +226,16 @@ Emitted when product types are created.
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-type.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -252,6 +252,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -269,6 +272,16 @@ Emitted when product variants are created.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+23
@@ -284,6 +284,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -301,6 +304,16 @@ Emitted when product variants are created.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -316,6 +329,16 @@ Emitted when products are created.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -183,6 +183,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -200,6 +203,16 @@ Emitted when product collections are deleted.
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-collection.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -183,6 +183,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -200,6 +203,16 @@ Emitted when product options are deleted.
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-option.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -182,6 +182,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -199,6 +202,16 @@ Emitted when product tags are deleted.
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-tag.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -183,6 +183,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -200,6 +203,16 @@ Emitted when product types are deleted.
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-type.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -185,6 +185,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -202,6 +205,16 @@ Emitted when product variants are deleted.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -185,6 +185,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -202,6 +205,16 @@ Emitted when products are deleted.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+43
@@ -222,6 +222,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -239,6 +242,16 @@ Emitted when product variants are created.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -254,6 +267,16 @@ Emitted when products are updated.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -269,6 +292,16 @@ Emitted when products are created.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
@@ -284,6 +317,16 @@ Emitted when products are deleted.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -218,6 +218,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -235,6 +238,16 @@ Emitted when product collections are updated.
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-collection.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -217,6 +217,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -234,6 +237,16 @@ Emitted when product options are updated.
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-option.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -218,6 +218,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -235,6 +238,16 @@ Emitted when product tags are updated.
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-tag.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -218,6 +218,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -235,6 +238,16 @@ Emitted when product types are updated.
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-type.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -400,6 +400,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -417,6 +420,16 @@ Emitted when product variants are updated.
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-variant.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -398,6 +398,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -415,6 +418,16 @@ Emitted when products are updated.
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -192,6 +192,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -209,6 +212,16 @@ Emitted when product categories are created.
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-category.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -173,6 +173,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -190,6 +193,16 @@ Emitted when product categories are deleted.
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-category.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -204,6 +204,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -221,6 +224,16 @@ Emitted when product categories are updated.
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "product-category.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -176,6 +176,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -193,6 +196,16 @@ Emitted when regions are created.
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "region.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -153,6 +153,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -170,6 +173,16 @@ Emitted when regions are deleted.
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "region.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -180,6 +180,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -197,6 +200,16 @@ Emitted when regions are updated.
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "region.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -164,6 +164,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -181,6 +184,16 @@ Emitted when sales channels are created.
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "sales-channel.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -153,6 +153,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -170,6 +173,16 @@ Emitted when sales channels are deleted.
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "sales-channel.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -176,6 +176,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -193,6 +196,16 @@ Emitted when sales channels are updated.
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "sales-channel.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -179,6 +179,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -196,6 +199,16 @@ Emitted when users are created.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -176,6 +176,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -193,6 +196,16 @@ Emitted when users are created.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.created",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -156,6 +156,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -173,6 +176,16 @@ Emitted when users are deleted.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -159,6 +159,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -176,6 +179,16 @@ Emitted when users are deleted.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.deleted",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+13
@@ -168,6 +168,9 @@ Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
@@ -185,6 +188,16 @@ Emitted when users are updated.
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "user.updated",
|
||||
payload: `\`\`\`ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AuthWorkflowEvents
|
||||
|
||||
`Const` **AuthWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"PASSWORD_RESET","type":"`string`","description":"Emitted when a reset password token is generated. You can listen to this event\nto send a reset password email to the user or customer, for example.","optional":false,"defaultValue":"\"auth.password_reset\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CartWorkflowEvents
|
||||
|
||||
`Const` **CartWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a cart is created.","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a cart's details are updated.","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"Emitted when the customer in the cart is updated.","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"Emitted when the cart's region is updated. This\nevent is emitted alongside the CartWorkflowEvents.UPDATED event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CustomerWorkflowEvents
|
||||
|
||||
`Const` **CustomerWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a customer is created.","optional":false,"defaultValue":"\"customer.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a customer is updated.","optional":false,"defaultValue":"\"customer.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when a customer is deleted.","optional":false,"defaultValue":"\"customer.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CustomerWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FulfillmentWorkflowEvents
|
||||
|
||||
`Const` **FulfillmentWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"SHIPMENT_CREATED","type":"`string`","description":"Emitted when a shipment is created for an order.","optional":false,"defaultValue":"\"shipment.created\"","expandable":false,"children":[]},{"name":"DELIVERY_CREATED","type":"`string`","description":"Emitted when a fulfillment is marked as delivered.","optional":false,"defaultValue":"\"delivery.created\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderEditWorkflowEvents
|
||||
|
||||
`Const` **OrderEditWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"REQUESTED","type":"`string`","description":"Emitted when an order edit is requested.","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`string`","description":"Emitted when an order edit request is confirmed.","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order edit request is canceled.","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEditWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderWorkflowEvents
|
||||
|
||||
`Const` **OrderWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when the details of an order or draft order is updated. This\ndoesn't include updates made by an edit.","optional":false,"defaultValue":"\"order.updated\"","expandable":false,"children":[]},{"name":"PLACED","type":"`string`","description":"Emitted when an order is placed, or when a draft order is converted to an\norder.","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order is canceld.","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"Emitted when orders are completed.","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"Emitted when an order is archived.","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"Emitted when a fulfillment is created for an order.","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"Emitted when an order's fulfillment is canceled.","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"Emitted when a return request is confirmed.","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"Emitted when a return is marked as received.","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"Emitted when a claim is created for an order.","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"Emitted when an exchange is created for an order.","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"Emitted when an order is requested to be transferred to\nanother customer.","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductCategoryWorkflowEvents
|
||||
|
||||
`Const` **ProductCategoryWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product categories are created.","optional":false,"defaultValue":"\"product-category.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product categories are updated.","optional":false,"defaultValue":"\"product-category.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product categories are deleted.","optional":false,"defaultValue":"\"product-category.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCategoryWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductCollectionWorkflowEvents
|
||||
|
||||
`Const` **ProductCollectionWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product collections are created.","optional":false,"defaultValue":"\"product-collection.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product collections are updated.","optional":false,"defaultValue":"\"product-collection.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product collections are deleted.","optional":false,"defaultValue":"\"product-collection.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCollectionWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductOptionWorkflowEvents
|
||||
|
||||
`Const` **ProductOptionWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product options are updated.","optional":false,"defaultValue":"\"product-option.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product options are created.","optional":false,"defaultValue":"\"product-option.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product options are deleted.","optional":false,"defaultValue":"\"product-option.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductOptionWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductTagWorkflowEvents
|
||||
|
||||
`Const` **ProductTagWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product tags are updated.","optional":false,"defaultValue":"\"product-tag.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product tags are created.","optional":false,"defaultValue":"\"product-tag.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product tags are deleted.","optional":false,"defaultValue":"\"product-tag.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTagWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductTypeWorkflowEvents
|
||||
|
||||
`Const` **ProductTypeWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product types are updated.","optional":false,"defaultValue":"\"product-type.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product types are created.","optional":false,"defaultValue":"\"product-type.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product types are deleted.","optional":false,"defaultValue":"\"product-type.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTypeWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductVariantWorkflowEvents
|
||||
|
||||
`Const` **ProductVariantWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product variants are updated.","optional":false,"defaultValue":"\"product-variant.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product variants are created.","optional":false,"defaultValue":"\"product-variant.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product variants are deleted.","optional":false,"defaultValue":"\"product-variant.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductVariantWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ProductWorkflowEvents
|
||||
|
||||
`Const` **ProductWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when products are updated.","optional":false,"defaultValue":"\"product.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when products are created.","optional":false,"defaultValue":"\"product.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when products are deleted.","optional":false,"defaultValue":"\"product.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RegionWorkflowEvents
|
||||
|
||||
`Const` **RegionWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when regions are updated.","optional":false,"defaultValue":"\"region.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when regions are created.","optional":false,"defaultValue":"\"region.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when regions are deleted.","optional":false,"defaultValue":"\"region.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RegionWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# SalesChannelWorkflowEvents
|
||||
|
||||
`Const` **SalesChannelWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when sales channels are created.","optional":false,"defaultValue":"\"sales-channel.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when sales channels are updated.","optional":false,"defaultValue":"\"sales-channel.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when sales channels are deleted.","optional":false,"defaultValue":"\"sales-channel.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SalesChannelWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# InviteWorkflowEvents
|
||||
|
||||
`Const` **InviteWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"ACCEPTED","type":"`string`","description":"Emitted when an invite is accepted.","optional":false,"defaultValue":"\"invite.accepted\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when invites are created. You can listen to this event\nto send an email to the invited users, for example.","optional":false,"defaultValue":"\"invite.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when invites are deleted.","optional":false,"defaultValue":"\"invite.deleted\"","expandable":false,"children":[]},{"name":"RESENT","type":"`string`","description":"Emitted when invites should be resent because their token was\nrefreshed. You can listen to this event to send an email to the invited users,\nfor example.","optional":false,"defaultValue":"\"invite.resent\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InviteWorkflowEvents"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UserWorkflowEvents
|
||||
|
||||
`Const` **UserWorkflowEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when users are created.","optional":false,"defaultValue":"\"user.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when users are updated.","optional":false,"defaultValue":"\"user.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when users are deleted.","optional":false,"defaultValue":"\"user.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UserWorkflowEvents"/>
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Auth
|
||||
|
||||
## Variables
|
||||
|
||||
- [AuthWorkflowEvents](../Auth/variables/events.Auth.AuthWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Cart
|
||||
|
||||
## Variables
|
||||
|
||||
- [CartWorkflowEvents](../Cart/variables/events.Cart.CartWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Customer
|
||||
|
||||
## Variables
|
||||
|
||||
- [CustomerWorkflowEvents](../Customer/variables/events.Customer.CustomerWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Fulfillment
|
||||
|
||||
## Variables
|
||||
|
||||
- [FulfillmentWorkflowEvents](../Fulfillment/variables/events.Fulfillment.FulfillmentWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,10 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Order
|
||||
|
||||
## Variables
|
||||
|
||||
- [OrderEditWorkflowEvents](../Order/variables/events.Order.OrderEditWorkflowEvents/page.mdx)
|
||||
- [OrderWorkflowEvents](../Order/variables/events.Order.OrderWorkflowEvents/page.mdx)
|
||||
|
||||
___
|
||||
@@ -0,0 +1,25 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Product
|
||||
|
||||
## Variables
|
||||
|
||||
- [ProductCategoryWorkflowEvents](../Product/variables/events.Product.ProductCategoryWorkflowEvents/page.mdx)
|
||||
- [ProductCollectionWorkflowEvents](../Product/variables/events.Product.ProductCollectionWorkflowEvents/page.mdx)
|
||||
- [ProductOptionWorkflowEvents](../Product/variables/events.Product.ProductOptionWorkflowEvents/page.mdx)
|
||||
- [ProductTagWorkflowEvents](../Product/variables/events.Product.ProductTagWorkflowEvents/page.mdx)
|
||||
- [ProductTypeWorkflowEvents](../Product/variables/events.Product.ProductTypeWorkflowEvents/page.mdx)
|
||||
- [ProductVariantWorkflowEvents](../Product/variables/events.Product.ProductVariantWorkflowEvents/page.mdx)
|
||||
- [ProductWorkflowEvents](../Product/variables/events.Product.ProductWorkflowEvents/page.mdx)
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Region
|
||||
|
||||
## Variables
|
||||
|
||||
- [RegionWorkflowEvents](../Region/variables/events.Region.RegionWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Sales Channel
|
||||
|
||||
## Variables
|
||||
|
||||
- [SalesChannelWorkflowEvents](../Sales_Channel/variables/events.Sales_Channel.SalesChannelWorkflowEvents/page.mdx)
|
||||
@@ -0,0 +1,10 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# User
|
||||
|
||||
## Variables
|
||||
|
||||
- [InviteWorkflowEvents](../User/variables/events.User.InviteWorkflowEvents/page.mdx)
|
||||
- [UserWorkflowEvents](../User/variables/events.User.UserWorkflowEvents/page.mdx)
|
||||
|
||||
___
|
||||
@@ -35,7 +35,13 @@ to send a reset password email to the user or customer, for example.
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `auth.password_reset`
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "authpassword_reset", children: (<>auth.password_reset</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="auth.password_reset" payload={`\`\`\`ts
|
||||
{
|
||||
entity_id, // The identifier of the user or customer. For example, an email address.
|
||||
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
||||
token, // The generated token.
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a reset password token is generated. You can listen to this event
|
||||
to send a reset password email to the user or customer, for example.
|
||||
@@ -52,4 +58,6 @@ to send a reset password email to the user or customer, for example.
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [generateResetPasswordTokenWorkflow](/references/medusa-workflows/generateResetPasswordTokenWorkflow)
|
||||
Loaded 100 of 113 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user