chore(docs): Generated References (automated) (#10016)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `fulfillment` - `inventory_next` - `js_sdk` - `modules` - `modules_sdk` - `order` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `types` - `user` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and 
GitHub committed
1 parent
1d2efb5ae3
commit
1cab15b209
113 files changed
+500481
-499982
No files matched your search
@@ -3489,6 +3489,7 @@ This step retrieves a region either by the provided ID or the first region in th
|
||||
|
||||
This step either finds a customer matching the specified ID, or finds / create a customer
|
||||
matching the specified email. If both ID and email are provided, ID takes precedence.
|
||||
If the customer is a guest, the email is updated to the provided email.
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3778,7 +3779,7 @@ This workflow creates a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createcartsstep","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} />
|
||||
<undefined workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createcartsstep","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3872,7 +3873,7 @@ This workflow updates a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateCartWorkflow","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"when","condition":"{\n return isDefined(cartInput.customer_id) || isDefined(cartInput.email)\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"5","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":7}]}} />
|
||||
<undefined workflow={{"name":"updateCartWorkflow","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5985,7 +5986,7 @@ This workflow adds line items to an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addOrderLineItemsWorkflow","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":4},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":5},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":6},{"type":"step","name":"createOrderLineItemsStep","description":"This step creates order line items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderlineitemsstep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"addOrderLineItemsWorkflow","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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":4},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":5},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":6},{"type":"step","name":"createOrderLineItemsStep","description":"This step creates order line items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderlineitemsstep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6578,7 +6579,7 @@ This workflow creates an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrdersWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":7},{"type":"hook","name":"orderCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCreated","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createOrdersWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"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/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":7},{"type":"hook","name":"orderCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCreated","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
|
||||
Reference in new issue
Block a user