asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: generate references after adding copy subscriber button (#12407)

Browse Source 
* docs: generate references after adding copy subscriber button

* re-generate
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-05-08 13:56:22 +03:00
1 parent 7ef13495d6
commit 41f46b7723
113 files changed
+170325 -164016
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
+15
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx
+33
View File
@@ -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>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.removeCustomerAccountWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflow/page.mdx
+68 -1
View File
@@ -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>
www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx
+23
View File
@@ -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>
www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx
+16 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx
+17 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx
+14
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx
+14
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx
+16 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx
+14
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx
+14
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx
+25
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx
+17 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx
+16 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx
+16 -2
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx
+14
View File
@@ -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>
www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx
+33
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx
+43
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx
+23
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.importProductsWorkflow/page.mdx
+43
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.createProductCategoriesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.deleteProductCategoriesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.updateProductCategoriesWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.createRegionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.deleteRegionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.updateRegionsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.createSalesChannelsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.deleteSalesChannelsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.updateSalesChannelsWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUserAccountWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.createUsersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.deleteUsersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.removeUserAccountWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/core_flows/User/Workflows_User/functions/core_flows.User.Workflows_User.updateUsersWorkflow/page.mdx
+13
View File
@@ -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>
www/apps/resources/references/events/Auth/variables/events.Auth.AuthWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Cart/variables/events.Cart.CartWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Customer/variables/events.Customer.CustomerWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Fulfillment/variables/events.Fulfillment.FulfillmentWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Order/variables/events.Order.OrderEditWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Order/variables/events.Order.OrderWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductCategoryWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductCollectionWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductOptionWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductTagWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductTypeWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductVariantWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Product/variables/events.Product.ProductWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Region/variables/events.Region.RegionWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/Sales_Channel/variables/events.Sales_Channel.SalesChannelWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/User/variables/events.User.InviteWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/User/variables/events.User.UserWorkflowEvents/page.mdx
+9
View File
@@ -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"/>
www/apps/resources/references/events/events.Auth/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Auth
## Variables
- [AuthWorkflowEvents](../Auth/variables/events.Auth.AuthWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.Cart/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Cart
## Variables
- [CartWorkflowEvents](../Cart/variables/events.Cart.CartWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.Customer/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Customer
## Variables
- [CustomerWorkflowEvents](../Customer/variables/events.Customer.CustomerWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.Fulfillment/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Fulfillment
## Variables
- [FulfillmentWorkflowEvents](../Fulfillment/variables/events.Fulfillment.FulfillmentWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.Order/page.mdx
+10
View File
@@ -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)
___
www/apps/resources/references/events/events.Product/page.mdx
+25
View File
@@ -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)
___
___
___
___
___
___
www/apps/resources/references/events/events.Region/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Region
## Variables
- [RegionWorkflowEvents](../Region/variables/events.Region.RegionWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.Sales_Channel/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Sales Channel
## Variables
- [SalesChannelWorkflowEvents](../Sales_Channel/variables/events.Sales_Channel.SalesChannelWorkflowEvents/page.mdx)
www/apps/resources/references/events/events.User/page.mdx
+10
View File
@@ -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)
___
www/apps/resources/references/module_events/module_events.Auth/page.mdx
+9 -1
View File
@@ -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)
www/apps/resources/references/module_events/module_events.Cart/page.mdx
+30 -6
View File
@@ -53,13 +53,17 @@ Emitted when the customer in the cart is updated.
</Table.Cell>
<Table.Cell>
Emitted when the cart's region is updated. This
event is emitted alongside the CartWorkflowEvents.UPDATED event.
event is emitted alongside the `cart.updated` event.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
## `cart.created`
<EventHeader headerLvl="2" headerProps={{ id: "cartcreated", children: (<>cart.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.created" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when a cart is created.
@@ -73,11 +77,17 @@ Emitted when a cart is created.
### 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.
- [createCartWorkflow](/references/medusa-workflows/createCartWorkflow)
---
## `cart.updated`
<EventHeader headerLvl="2" headerProps={{ id: "cartupdated", children: (<>cart.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.updated" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when a cart's details are updated.
@@ -91,6 +101,8 @@ Emitted when a cart's details are updated.
### 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.
- [updateLineItemInCartWorkflow](/references/medusa-workflows/updateLineItemInCartWorkflow)
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
- [addToCartWorkflow](/references/medusa-workflows/addToCartWorkflow)
@@ -98,7 +110,11 @@ Emitted when a cart's details are updated.
---
## `cart.customer_updated`
<EventHeader headerLvl="2" headerProps={{ id: "cartcustomer_updated", children: (<>cart.customer_updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.customer_updated" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when the customer in the cart is updated.
@@ -112,14 +128,20 @@ Emitted when the customer in the cart is updated.
### 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.
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
---
## `cart.region_updated`
<EventHeader headerLvl="2" headerProps={{ id: "cartregion_updated", children: (<>cart.region_updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.region_updated" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when the cart's region is updated. This
event is emitted alongside the CartWorkflowEvents.UPDATED event.
event is emitted alongside the `cart.updated` event.
### Payload
@@ -131,4 +153,6 @@ event is emitted alongside the CartWorkflowEvents.UPDATED event.
### 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.
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
www/apps/resources/references/module_events/module_events.Customer/page.mdx
+21 -3
View File
@@ -50,7 +50,11 @@ Emitted when a customer is deleted.
</Table.Body>
</Table>
## `customer.created`
<EventHeader headerLvl="2" headerProps={{ id: "customercreated", children: (<>customer.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.created" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is created.
@@ -64,12 +68,18 @@ Emitted when a customer is created.
### 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.
- [createCustomersWorkflow](/references/medusa-workflows/createCustomersWorkflow)
- [createCustomerAccountWorkflow](/references/medusa-workflows/createCustomerAccountWorkflow)
---
## `customer.updated`
<EventHeader headerLvl="2" headerProps={{ id: "customerupdated", children: (<>customer.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.updated" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is updated.
@@ -83,11 +93,17 @@ Emitted when a customer is updated.
### 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.
- [updateCustomersWorkflow](/references/medusa-workflows/updateCustomersWorkflow)
---
## `customer.deleted`
<EventHeader headerLvl="2" headerProps={{ id: "customerdeleted", children: (<>customer.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.deleted" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is deleted.
@@ -101,5 +117,7 @@ Emitted when a customer is deleted.
### 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.
- [deleteCustomersWorkflow](/references/medusa-workflows/deleteCustomersWorkflow)
- [removeCustomerAccountWorkflow](/references/medusa-workflows/removeCustomerAccountWorkflow)
Loaded 100 of 113 files, more files were not shown because too many files have changed in this diff. Show more