chore(docs): Generated References (automated) (#12460)
Generated the following references: - `_index.mdx` - `api_key` - `api_key_models` - `auth` - `auth_models` - `auth_provider` - `cart` - `cart_models` - `core_flows` - `currency` - `currency_models` - `customer` - `customer_models` - `events` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `fulfillment_provider` - `inventory_next` - `inventory_next_models` - `js_sdk` - `locking` - `medusa` - `module_events` - `modules` - `modules_sdk` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `payment_provider` - `pricing` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region` - `region_models` - `sales_channel` - `sales_channel_models` - `stock_location_next` - `stock_location_next_models` - `store` - `store_models` - `tax` - `tax_models` - `tax_provider` - `types` - `user` - `user_models` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1978 files changed
+332243
-279592
No files matched your search
@@ -66,6 +66,8 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [AddDraftOrderPromotionWorkflowInput](../../core_flows/interfaces/core_flows.AddDraftOrderPromotionWorkflowInput/page.mdx)
|
||||
- [AddDraftOrderShippingMethodsWorkflowInput](../../core_flows/interfaces/core_flows.AddDraftOrderShippingMethodsWorkflowInput/page.mdx)
|
||||
- [AddShippingMethodToCartStepInput](../../core_flows/interfaces/core_flows.AddShippingMethodToCartStepInput/page.mdx)
|
||||
- [AddShippingMethodToCartWorkflowInput](../../core_flows/interfaces/core_flows.AddShippingMethodToCartWorkflowInput/page.mdx)
|
||||
- [AssociateLocationsWithSalesChannelsStepInput](../../core_flows/interfaces/core_flows.AssociateLocationsWithSalesChannelsStepInput/page.mdx)
|
||||
@@ -84,6 +86,8 @@ import { TypeList } from "docs-ui"
|
||||
- [ConfirmDraftOrderEditWorkflowInput](../../core_flows/interfaces/core_flows.ConfirmDraftOrderEditWorkflowInput/page.mdx)
|
||||
- [ConfirmVariantInventoryStepInput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryStepInput/page.mdx)
|
||||
- [ConfirmVariantInventoryWorkflowOutput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryWorkflowOutput/page.mdx)
|
||||
- [ConvertDraftOrderStepInput](../../core_flows/interfaces/core_flows.ConvertDraftOrderStepInput/page.mdx)
|
||||
- [ConvertDraftOrderWorkflowInput](../../core_flows/interfaces/core_flows.ConvertDraftOrderWorkflowInput/page.mdx)
|
||||
- [CreateDefaultSalesChannelStepInput](../../core_flows/interfaces/core_flows.CreateDefaultSalesChannelStepInput/page.mdx)
|
||||
- [CreateInventoryItemsWorkflowInput](../../core_flows/interfaces/core_flows.CreateInventoryItemsWorkflowInput/page.mdx)
|
||||
- [CreateInventoryLevelsWorkflowInput](../../core_flows/interfaces/core_flows.CreateInventoryLevelsWorkflowInput/page.mdx)
|
||||
@@ -121,7 +125,11 @@ import { TypeList } from "docs-ui"
|
||||
- [ListShippingOptionsForContextStepInput](../../core_flows/interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx)
|
||||
- [PrepareAdjustmentsFromPromotionActionsStepInput](../../core_flows/interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput/page.mdx)
|
||||
- [PrepareAdjustmentsFromPromotionActionsStepOutput](../../core_flows/interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepOutput/page.mdx)
|
||||
- [ProcessPaymentWorkflowInput](../../core_flows/interfaces/core_flows.ProcessPaymentWorkflowInput/page.mdx)
|
||||
- [refundPaymentAndRecreatePaymentSessionWorkflowInput](../../core_flows/interfaces/core_flows.refundPaymentAndRecreatePaymentSessionWorkflowInput/page.mdx)
|
||||
- [RemoteStepInput](../../core_flows/interfaces/core_flows.RemoteStepInput/page.mdx)
|
||||
- [RemoveDraftOrderPromotionsWorkflowInput](../../core_flows/interfaces/core_flows.RemoveDraftOrderPromotionsWorkflowInput/page.mdx)
|
||||
- [RemoveDraftOrderShippingMethodWorkflowInput](../../core_flows/interfaces/core_flows.RemoveDraftOrderShippingMethodWorkflowInput/page.mdx)
|
||||
- [RemoveLineItemAdjustmentsStepInput](../../core_flows/interfaces/core_flows.RemoveLineItemAdjustmentsStepInput/page.mdx)
|
||||
- [RemoveShippingMethodAdjustmentsStepInput](../../core_flows/interfaces/core_flows.RemoveShippingMethodAdjustmentsStepInput/page.mdx)
|
||||
- [RemoveShippingMethodFromCartStepInput](../../core_flows/interfaces/core_flows.RemoveShippingMethodFromCartStepInput/page.mdx)
|
||||
@@ -134,6 +142,7 @@ import { TypeList } from "docs-ui"
|
||||
- [ShippingOptionsPriceCurrencyCode](../../core_flows/interfaces/core_flows.ShippingOptionsPriceCurrencyCode/page.mdx)
|
||||
- [UpdateCartPromotionStepInput](../../core_flows/interfaces/core_flows.UpdateCartPromotionStepInput/page.mdx)
|
||||
- [UpdateDraftOrderShippingMethodWorkflowInput](../../core_flows/interfaces/core_flows.UpdateDraftOrderShippingMethodWorkflowInput/page.mdx)
|
||||
- [UpdateDraftOrderStepInput](../../core_flows/interfaces/core_flows.UpdateDraftOrderStepInput/page.mdx)
|
||||
- [UpdateDraftOrderWorkflowInput](../../core_flows/interfaces/core_flows.UpdateDraftOrderWorkflowInput/page.mdx)
|
||||
- [UpdateInventoryItemsWorkflowInput](../../core_flows/interfaces/core_flows.UpdateInventoryItemsWorkflowInput/page.mdx)
|
||||
- [UpdateInventoryLevelsWorkflowInput](../../core_flows/interfaces/core_flows.UpdateInventoryLevelsWorkflowInput/page.mdx)
|
||||
@@ -144,6 +153,7 @@ import { TypeList } from "docs-ui"
|
||||
- [ValidateCartShippingOptionsStepInput](../../core_flows/interfaces/core_flows.ValidateCartShippingOptionsStepInput/page.mdx)
|
||||
- [ValidateCartStepInput](../../core_flows/interfaces/core_flows.ValidateCartStepInput/page.mdx)
|
||||
- [ValidateDeletedPaymentSessionsStepInput](../../core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput/page.mdx)
|
||||
- [ValidateDraftOrderStepInput](../../core_flows/interfaces/core_flows.ValidateDraftOrderStepInput/page.mdx)
|
||||
- [ValidateInventoryDeleteStepInput](../../core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput/page.mdx)
|
||||
- [ValidateLineItemPricesStepInput](../../core_flows/interfaces/core_flows.ValidateLineItemPricesStepInput/page.mdx)
|
||||
- [ValidateProductInputStepInput](../../core_flows/interfaces/core_flows.ValidateProductInputStepInput/page.mdx)
|
||||
@@ -426,6 +436,7 @@ import { TypeList } from "docs-ui"
|
||||
- [MarkOrderFulfillmentAsDeliveredWorkflowInput](../../core_flows/types/core_flows.MarkOrderFulfillmentAsDeliveredWorkflowInput/page.mdx)
|
||||
- [MarkPaymentCollectionAsPaidInput](../../core_flows/types/core_flows.MarkPaymentCollectionAsPaidInput/page.mdx)
|
||||
- [MaybeListTaxRateRuleIdsStepInput](../../core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx)
|
||||
- [MaybeRefreshShippingMethodsWorkflowInput](../../core_flows/types/core_flows.MaybeRefreshShippingMethodsWorkflowInput/page.mdx)
|
||||
- [MaybeUnsetDefaultBillingAddressStepInput](../../core_flows/types/core_flows.MaybeUnsetDefaultBillingAddressStepInput/page.mdx)
|
||||
- [MaybeUnsetDefaultShippingAddressesStepInput](../../core_flows/types/core_flows.MaybeUnsetDefaultShippingAddressesStepInput/page.mdx)
|
||||
- [NotifyOnFailureStepInput](../../core_flows/types/core_flows.NotifyOnFailureStepInput/page.mdx)
|
||||
@@ -592,7 +603,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO\\_3166-2) province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/>
|
||||
|
||||
### addressesDeleted
|
||||
|
||||
@@ -604,7 +615,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO\\_3166-2) province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/>
|
||||
|
||||
### apiKeysCreated
|
||||
|
||||
@@ -862,6 +873,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx) & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option to fetch.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`CalculatedRMAShippingContext`","description":"The context of the RMA flow, which can be useful for retrieving the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record<string, unknown>`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_amount","type":"`null` \\| [BigNumberInput](../../types/types/types.BigNumberInput/page.mdx)","description":"The custom amount of the shipping option.\nIf not provided, the shipping option's amount is used.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setPricingContext"/>
|
||||
|
||||
### setPricingContext
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_exchange","type":"[OrderExchangeDTO](../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)","description":"The exchange details.","optional":false,"defaultValue":"orderExchange","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Whether the customer should receive notifications related\nto updates on the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The difference due of the order exchange.\n\n- If less than `0`, the merchant owes the customer this amount.\n- If greater than `0`, the customer owes the merchange this amount.\n- If equal to `0`, no payment is required by either sides.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_difference_due","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The raw difference due of the order exchange.\n\n- If less than `0`, the merchant owes the customer this amount.\n- If greater than `0`, the customer owes the merchange this amount.\n- If equal to `0`, no payment is required by either sides.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the variants that are out of stock can be added to the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)","description":"The associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the order exchange","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The shipping methods used to send the additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"[OrderTransactionDTO](../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The exchange's transactions if additional payment is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"The deletion date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The cancelation date of the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order_change","type":"[OrderChangeDTO](../../fulfillment/interfaces/fulfillment.OrderChangeDTO/page.mdx)","description":"The order change details.","optional":false,"defaultValue":"orderChange","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":falsLine truncated
|
||||
|
||||
### setPricingContext
|
||||
@@ -888,12 +905,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_return","type":"[ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)","description":"The return details.","optional":false,"defaultValue":"orderReturn","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../fulfillment/types/fulfillment.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../fulfillment/interfaces/fulfillment.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refund_amount","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)","description":"The associated exchange.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../fulfillment/interfaces/fulfillment.OrderClaimDTO/page.mdx)","description":"The associated claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location to return the items to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Whether the customer should receive notifications related\nto updates on the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The shipping methods used to receive the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"[OrderTransactionDTO](../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The return's transactions if refund is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"The deletion date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The cancelation date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`string` \\| `Date`","description":"The request date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string` \\| `Date`","description":"The receival date of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order_change","type":"[OrderChangeDTOLine truncated
|
||||
|
||||
### setPricingContext
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"`input`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setPricingContext"/>
|
||||
|
||||
### shipmentCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -48,6 +48,15 @@ Emitted when a cart's details are updated.
|
||||
<Table.Cell>
|
||||
Emitted when the cart's region is updated. This
|
||||
event is emitted alongside the `cart.updated` event.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.customer_transferred](#cartcustomer_transferred)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when the customer in the cart is transferred.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
@@ -129,6 +138,35 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "cartcustomer_transferred", children: (<>cart.customer_transferred
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.customer_transferred" payload={`\`\`\`ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
customer_id, // The ID of the customer
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when the customer in the cart is transferred.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
customer_id, // The ID of the customer
|
||||
}
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
- [transferCartCustomerWorkflow](/references/medusa-workflows/transferCartCustomerWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Customer Events
|
||||
|
||||
### Summary
|
||||
@@ -678,6 +716,139 @@ The following workflows emit this event when they're executed. These workflows a
|
||||
|
||||
---
|
||||
|
||||
## Order Edit Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.requested](#order-editrequested)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit is requested.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.confirmed](#order-editconfirmed)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is confirmed.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.canceled](#order-editcanceled)
|
||||
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is canceled.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editrequested", children: (<>order-edit.requested
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="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
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit is 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
|
||||
}
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
- [requestOrderEditRequestWorkflow](/references/medusa-workflows/requestOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editconfirmed", children: (<>order-edit.confirmed
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="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
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit request is 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
|
||||
}
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
- [confirmOrderEditRequestWorkflow](/references/medusa-workflows/confirmOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "order-editcanceled", children: (<>order-edit.canceled
|
||||
<Tooltip text="This event was added in version v2.8.0">
|
||||
<Badge variant="blue">v2.8.0</Badge>
|
||||
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="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
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when an order edit request is 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
|
||||
}
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
- [cancelBeginOrderEditWorkflow](/references/medusa-workflows/cancelBeginOrderEditWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## User Events
|
||||
|
||||
### Summary
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### 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](../../module_events/module_events.Cart/page.mdx#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"/>
|
||||
<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 `cart.updated` event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_TRANSFERRED","type":"`string`","description":"Emitted when the customer in the cart is transferred.","optional":false,"defaultValue":"\"cart.customer_transferred\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ import { TypeList } from "docs-ui"
|
||||
- [CreateTaxRateDTO](../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)
|
||||
- [CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)
|
||||
- [CreateTaxRegionDTO](../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)
|
||||
- [FilterableTaxProviderProps](../../tax/interfaces/tax.FilterableTaxProviderProps/page.mdx)
|
||||
- [FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)
|
||||
- [FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)
|
||||
- [FilterableTaxRegionProps](../../tax/interfaces/tax.FilterableTaxRegionProps/page.mdx)
|
||||
@@ -28,6 +29,7 @@ import { TypeList } from "docs-ui"
|
||||
- [TaxableShippingDTO](../../tax/interfaces/tax.TaxableShippingDTO/page.mdx)
|
||||
- [TaxCalculationContext](../../tax/interfaces/tax.TaxCalculationContext/page.mdx)
|
||||
- [TaxLineDTO](../../tax/interfaces/tax.TaxLineDTO/page.mdx)
|
||||
- [TaxProviderDTO](../../tax/interfaces/tax.TaxProviderDTO/page.mdx)
|
||||
- [TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)
|
||||
- [TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)
|
||||
- [TaxRegionDTO](../../tax/interfaces/tax.TaxRegionDTO/page.mdx)
|
||||
|
||||
@@ -18,16 +18,25 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Auth](../../utils/utils.Auth/page.mdx)
|
||||
- [Cart](../../utils/utils.Cart/page.mdx)
|
||||
- [CoreFlowsUitls](../../utils/utils.CoreFlowsUitls/page.mdx)
|
||||
- [Customer](../../utils/utils.Customer/page.mdx)
|
||||
- [Fulfillment](../../utils/utils.Fulfillment/page.mdx)
|
||||
- [FulfillmentUtils](../../utils/utils.FulfillmentUtils/page.mdx)
|
||||
- [GraphQLUtils](../../utils/utils.GraphQLUtils/page.mdx)
|
||||
- [InventoryUtils](../../utils/utils.InventoryUtils/page.mdx)
|
||||
- [LinkUtils](../../utils/utils.LinkUtils/page.mdx)
|
||||
- [Order](../../utils/utils.Order/page.mdx)
|
||||
- [OrderUtils](../../utils/utils.OrderUtils/page.mdx)
|
||||
- [PricingUtils](../../utils/utils.PricingUtils/page.mdx)
|
||||
- [Product](../../utils/utils.Product/page.mdx)
|
||||
- [ProductUtils](../../utils/utils.ProductUtils/page.mdx)
|
||||
- [PromotionUtils](../../utils/utils.PromotionUtils/page.mdx)
|
||||
- [Region](../../utils/utils.Region/page.mdx)
|
||||
- [Sales Channel](../../utils/utils.Sales_Channel/page.mdx)
|
||||
- [ShippingProfileUtils](../../utils/utils.ShippingProfileUtils/page.mdx)
|
||||
- [User](../../utils/utils.User/page.mdx)
|
||||
- [UserUtils](../../utils/utils.UserUtils/page.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
Reference in new issue
Block a user