chore: generate core-flows reference for 2.3.0 (#11028)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
e50d0ff369
commit
bff8c0bc93
1055 files changed
+289674
-279277
No files matched your search
@@ -40,8 +40,20 @@ import { TypeList } from "docs-ui"
|
||||
- [productVariantsUpdated](page.mdx#productvariantsupdated)
|
||||
- [promotionsCreated](page.mdx#promotionscreated)
|
||||
- [promotionsDeleted](page.mdx#promotionsdeleted)
|
||||
- [promotionStatusUpdated](page.mdx#promotionstatusupdated)
|
||||
- [promotionsUpdated](page.mdx#promotionsupdated)
|
||||
- [shipmentCreated](page.mdx#shipmentcreated)
|
||||
- [validate](page.mdx#validate)
|
||||
- [validate](page.mdx#validate-1)
|
||||
- [validate](page.mdx#validate-2)
|
||||
- [validate](page.mdx#validate-3)
|
||||
- [validate](page.mdx#validate-4)
|
||||
- [validate](page.mdx#validate-5)
|
||||
- [validate](page.mdx#validate-6)
|
||||
- [validate](page.mdx#validate-7)
|
||||
- [validate](page.mdx#validate-8)
|
||||
- [validate](page.mdx#validate-9)
|
||||
- [validate](page.mdx#validate-10)
|
||||
|
||||
## Interfaces
|
||||
|
||||
@@ -65,6 +77,8 @@ import { TypeList } from "docs-ui"
|
||||
- [CreateShippingMethodAdjustmentsStepInput](../../core_flows/interfaces/core_flows.CreateShippingMethodAdjustmentsStepInput/page.mdx)
|
||||
- [CreateStockLocationsWorkflowInput](../../core_flows/interfaces/core_flows.CreateStockLocationsWorkflowInput/page.mdx)
|
||||
- [DeleteInventoryLevelsWorkflowInput](../../core_flows/interfaces/core_flows.DeleteInventoryLevelsWorkflowInput/page.mdx)
|
||||
- [DeleteOrderChangeActionsStepInput](../../core_flows/interfaces/core_flows.DeleteOrderChangeActionsStepInput/page.mdx)
|
||||
- [DeleteOrderChangesStepInput](../../core_flows/interfaces/core_flows.DeleteOrderChangesStepInput/page.mdx)
|
||||
- [DeleteOrderLineItemsStepInput](../../core_flows/interfaces/core_flows.DeleteOrderLineItemsStepInput/page.mdx)
|
||||
- [DeleteOrderShippingMethodsStepInput](../../core_flows/interfaces/core_flows.DeleteOrderShippingMethodsStepInput/page.mdx)
|
||||
- [DeletePaymentSessionStepInput](../../core_flows/interfaces/core_flows.DeletePaymentSessionStepInput/page.mdx)
|
||||
@@ -79,12 +93,15 @@ import { TypeList } from "docs-ui"
|
||||
- [GetActionsToComputeFromPromotionsStepInput](../../core_flows/interfaces/core_flows.GetActionsToComputeFromPromotionsStepInput/page.mdx)
|
||||
- [GetItemTaxLinesStepInput](../../core_flows/interfaces/core_flows.GetItemTaxLinesStepInput/page.mdx)
|
||||
- [GetLineItemActionsStepInput](../../core_flows/interfaces/core_flows.GetLineItemActionsStepInput/page.mdx)
|
||||
- [GetLineItemActionsStepOutput](../../core_flows/interfaces/core_flows.GetLineItemActionsStepOutput/page.mdx)
|
||||
- [GetPromotionCodesToApplyStepInput](../../core_flows/interfaces/core_flows.GetPromotionCodesToApplyStepInput/page.mdx)
|
||||
- [GetVariantPriceSetsStepInput](../../core_flows/interfaces/core_flows.GetVariantPriceSetsStepInput/page.mdx)
|
||||
- [GetVariantPriceSetsStepOutput](../../core_flows/interfaces/core_flows.GetVariantPriceSetsStepOutput/page.mdx)
|
||||
- [GetVariantsStepInput](../../core_flows/interfaces/core_flows.GetVariantsStepInput/page.mdx)
|
||||
- [ListLineItemsStepInput](../../core_flows/interfaces/core_flows.ListLineItemsStepInput/page.mdx)
|
||||
- [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)
|
||||
- [RemoteStepInput](../../core_flows/interfaces/core_flows.RemoteStepInput/page.mdx)
|
||||
- [RemoveLineItemAdjustmentsStepInput](../../core_flows/interfaces/core_flows.RemoveLineItemAdjustmentsStepInput/page.mdx)
|
||||
- [RemoveShippingMethodAdjustmentsStepInput](../../core_flows/interfaces/core_flows.RemoveShippingMethodAdjustmentsStepInput/page.mdx)
|
||||
@@ -93,6 +110,7 @@ import { TypeList } from "docs-ui"
|
||||
- [RetrieveCartStepInput](../../core_flows/interfaces/core_flows.RetrieveCartStepInput/page.mdx)
|
||||
- [ServiceStepInput](../../core_flows/interfaces/core_flows.ServiceStepInput/page.mdx)
|
||||
- [SetOrderTaxLinesForItemsStepInput](../../core_flows/interfaces/core_flows.SetOrderTaxLinesForItemsStepInput/page.mdx)
|
||||
- [SetRegionsPaymentProvidersStepInput](../../core_flows/interfaces/core_flows.SetRegionsPaymentProvidersStepInput/page.mdx)
|
||||
- [SetTaxLinesForItemsStepInput](../../core_flows/interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx)
|
||||
- [ShippingOptionsPriceCurrencyCode](../../core_flows/interfaces/core_flows.ShippingOptionsPriceCurrencyCode/page.mdx)
|
||||
- [UpdateCartPromotionStepInput](../../core_flows/interfaces/core_flows.UpdateCartPromotionStepInput/page.mdx)
|
||||
@@ -100,12 +118,14 @@ import { TypeList } from "docs-ui"
|
||||
- [UpdateInventoryLevelsWorkflowInput](../../core_flows/interfaces/core_flows.UpdateInventoryLevelsWorkflowInput/page.mdx)
|
||||
- [UpdateLineItemsStepInput](../../core_flows/interfaces/core_flows.UpdateLineItemsStepInput/page.mdx)
|
||||
- [UpdatePaymentCollectionStepInput](../../core_flows/interfaces/core_flows.UpdatePaymentCollectionStepInput/page.mdx)
|
||||
- [UpdateReturnItemBySelector](../../core_flows/interfaces/core_flows.UpdateReturnItemBySelector/page.mdx)
|
||||
- [UpdateStockLocationsWorkflowInput](../../core_flows/interfaces/core_flows.UpdateStockLocationsWorkflowInput/page.mdx)
|
||||
- [ValidateCartPaymentsStepInput](../../core_flows/interfaces/core_flows.ValidateCartPaymentsStepInput/page.mdx)
|
||||
- [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)
|
||||
- [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)
|
||||
- [ValidateSalesChannelsExistStepInput](../../core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput/page.mdx)
|
||||
- [ValidateVariantPricesStepInput](../../core_flows/interfaces/core_flows.ValidateVariantPricesStepInput/page.mdx)
|
||||
|
||||
@@ -145,113 +165,346 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [AcceptOrderTransferValidationStepInput](../../core_flows/types/core_flows.AcceptOrderTransferValidationStepInput/page.mdx)
|
||||
- [AddOrderTransactionStepInput](../../core_flows/types/core_flows.AddOrderTransactionStepInput/page.mdx)
|
||||
- [AddOrderTransactionStepOutput](../../core_flows/types/core_flows.AddOrderTransactionStepOutput/page.mdx)
|
||||
- [AddOrRemoveCampaignPromotionsWorkflowInput](../../core_flows/types/core_flows.AddOrRemoveCampaignPromotionsWorkflowInput/page.mdx)
|
||||
- [AdjustInventoryLevelsStepInput](../../core_flows/types/core_flows.AdjustInventoryLevelsStepInput/page.mdx)
|
||||
- [ArchiveOrdersStepInput](../../core_flows/types/core_flows.ArchiveOrdersStepInput/page.mdx)
|
||||
- [ArchiveOrdersWorkflowInput](../../core_flows/types/core_flows.ArchiveOrdersWorkflowInput/page.mdx)
|
||||
- [ArchiveOrdersWorkflowOutput](../../core_flows/types/core_flows.ArchiveOrdersWorkflowOutput/page.mdx)
|
||||
- [AttachInventoryItemToVariantsStepInput](../../core_flows/types/core_flows.AttachInventoryItemToVariantsStepInput/page.mdx)
|
||||
- [AuthorizePaymentSessionStepInput](../../core_flows/types/core_flows.AuthorizePaymentSessionStepInput/page.mdx)
|
||||
- [BatchInventoryItemLevelsWorkflowOutput](../../core_flows/types/core_flows.BatchInventoryItemLevelsWorkflowOutput/page.mdx)
|
||||
- [BatchPriceListPricesWorkflowInput](../../core_flows/types/core_flows.BatchPriceListPricesWorkflowInput/page.mdx)
|
||||
- [BatchProductVariantsWorkflowInput](../../core_flows/types/core_flows.BatchProductVariantsWorkflowInput/page.mdx)
|
||||
- [BatchProductVariantsWorkflowOutput](../../core_flows/types/core_flows.BatchProductVariantsWorkflowOutput/page.mdx)
|
||||
- [BatchProductWorkflowInput](../../core_flows/types/core_flows.BatchProductWorkflowInput/page.mdx)
|
||||
- [BatchPromotionRulesWorkflowInput](../../core_flows/types/core_flows.BatchPromotionRulesWorkflowInput/page.mdx)
|
||||
- [BatchPromotionRulesWorkflowOutput](../../core_flows/types/core_flows.BatchPromotionRulesWorkflowOutput/page.mdx)
|
||||
- [BatchShippingOptionRulesInput](../../core_flows/types/core_flows.BatchShippingOptionRulesInput/page.mdx)
|
||||
- [BatchShippingOptionRulesOutput](../../core_flows/types/core_flows.BatchShippingOptionRulesOutput/page.mdx)
|
||||
- [BeginClaimOrderValidationStepInput](../../core_flows/types/core_flows.BeginClaimOrderValidationStepInput/page.mdx)
|
||||
- [BeginOrderEditValidationStepInput](../../core_flows/types/core_flows.BeginOrderEditValidationStepInput/page.mdx)
|
||||
- [BeginOrderExchangeValidationStepInput](../../core_flows/types/core_flows.BeginOrderExchangeValidationStepInput/page.mdx)
|
||||
- [BeginReceiveReturnValidationStepInput](../../core_flows/types/core_flows.BeginReceiveReturnValidationStepInput/page.mdx)
|
||||
- [BeginReturnOrderValidationStepInput](../../core_flows/types/core_flows.BeginReturnOrderValidationStepInput/page.mdx)
|
||||
- [CalculateShippingOptionsPriceStepInput](../../core_flows/types/core_flows.CalculateShippingOptionsPriceStepInput/page.mdx)
|
||||
- [CancelBeginOrderClaimValidationStepInput](../../core_flows/types/core_flows.CancelBeginOrderClaimValidationStepInput/page.mdx)
|
||||
- [CancelBeginOrderClaimWorkflowInput](../../core_flows/types/core_flows.CancelBeginOrderClaimWorkflowInput/page.mdx)
|
||||
- [CancelBeginOrderEditValidationStepInput](../../core_flows/types/core_flows.CancelBeginOrderEditValidationStepInput/page.mdx)
|
||||
- [CancelBeginOrderEditWorkflowInput](../../core_flows/types/core_flows.CancelBeginOrderEditWorkflowInput/page.mdx)
|
||||
- [CancelBeginOrderExchangeValidationStepInput](../../core_flows/types/core_flows.CancelBeginOrderExchangeValidationStepInput/page.mdx)
|
||||
- [CancelBeginOrderExchangeWorkflowInput](../../core_flows/types/core_flows.CancelBeginOrderExchangeWorkflowInput/page.mdx)
|
||||
- [CancelClaimValidateOrderStepInput](../../core_flows/types/core_flows.CancelClaimValidateOrderStepInput/page.mdx)
|
||||
- [CancelExchangeValidateOrderStepInput](../../core_flows/types/core_flows.CancelExchangeValidateOrderStepInput/page.mdx)
|
||||
- [CancelFulfillmentStepInput](../../core_flows/types/core_flows.CancelFulfillmentStepInput/page.mdx)
|
||||
- [CancelFulfillmentWorkflowInput](../../core_flows/types/core_flows.CancelFulfillmentWorkflowInput/page.mdx)
|
||||
- [CancelOrderFulfillmentValidateOrderStep](../../core_flows/types/core_flows.CancelOrderFulfillmentValidateOrderStep/page.mdx)
|
||||
- [CancelOrderFulfillmentWorkflowInput](../../core_flows/types/core_flows.CancelOrderFulfillmentWorkflowInput/page.mdx)
|
||||
- [CancelOrdersStepInput](../../core_flows/types/core_flows.CancelOrdersStepInput/page.mdx)
|
||||
- [CancelPaymentStepInput](../../core_flows/types/core_flows.CancelPaymentStepInput/page.mdx)
|
||||
- [CancelReceiveReturnValidationStepInput](../../core_flows/types/core_flows.CancelReceiveReturnValidationStepInput/page.mdx)
|
||||
- [CancelRequestReturnValidationStepInput](../../core_flows/types/core_flows.CancelRequestReturnValidationStepInput/page.mdx)
|
||||
- [CancelRequestReturnWorkflowInput](../../core_flows/types/core_flows.CancelRequestReturnWorkflowInput/page.mdx)
|
||||
- [CancelReturnReceiveWorkflowInput](../../core_flows/types/core_flows.CancelReturnReceiveWorkflowInput/page.mdx)
|
||||
- [CancelReturnValidateOrderInput](../../core_flows/types/core_flows.CancelReturnValidateOrderInput/page.mdx)
|
||||
- [CancelTransferOrderRequestValidationStep](../../core_flows/types/core_flows.CancelTransferOrderRequestValidationStep/page.mdx)
|
||||
- [CancelValidateOrderStepInput](../../core_flows/types/core_flows.CancelValidateOrderStepInput/page.mdx)
|
||||
- [CanDeleteSalesChannelsOrThrowStepInput](../../core_flows/types/core_flows.CanDeleteSalesChannelsOrThrowStepInput/page.mdx)
|
||||
- [CapturePaymentStepInput](../../core_flows/types/core_flows.CapturePaymentStepInput/page.mdx)
|
||||
- [CapturePaymentWorkflowInput](../../core_flows/types/core_flows.CapturePaymentWorkflowInput/page.mdx)
|
||||
- [CompleteCartWorkflowInput](../../core_flows/types/core_flows.CompleteCartWorkflowInput/page.mdx)
|
||||
- [CompleteCartWorkflowOutput](../../core_flows/types/core_flows.CompleteCartWorkflowOutput/page.mdx)
|
||||
- [CompleteOrdersStepInput](../../core_flows/types/core_flows.CompleteOrdersStepInput/page.mdx)
|
||||
- [CompleteOrdersWorkflowInput](../../core_flows/types/core_flows.CompleteOrdersWorkflowInput/page.mdx)
|
||||
- [ConfirmClaimRequestValidationStepInput](../../core_flows/types/core_flows.ConfirmClaimRequestValidationStepInput/page.mdx)
|
||||
- [ConfirmClaimRequestWorkflowInput](../../core_flows/types/core_flows.ConfirmClaimRequestWorkflowInput/page.mdx)
|
||||
- [ConfirmExchangeRequestValidationStepInput](../../core_flows/types/core_flows.ConfirmExchangeRequestValidationStepInput/page.mdx)
|
||||
- [ConfirmExchangeRequestWorkflowInput](../../core_flows/types/core_flows.ConfirmExchangeRequestWorkflowInput/page.mdx)
|
||||
- [ConfirmOrderEditRequestValidationStepInput](../../core_flows/types/core_flows.ConfirmOrderEditRequestValidationStepInput/page.mdx)
|
||||
- [ConfirmOrderEditRequestWorkflowInput](../../core_flows/types/core_flows.ConfirmOrderEditRequestWorkflowInput/page.mdx)
|
||||
- [ConfirmReceiveReturnRequestWorkflowInput](../../core_flows/types/core_flows.ConfirmReceiveReturnRequestWorkflowInput/page.mdx)
|
||||
- [ConfirmReceiveReturnValidationStepInput](../../core_flows/types/core_flows.ConfirmReceiveReturnValidationStepInput/page.mdx)
|
||||
- [ConfirmReturnRequestValidationStepInput](../../core_flows/types/core_flows.ConfirmReturnRequestValidationStepInput/page.mdx)
|
||||
- [ConfirmReturnRequestWorkflowInput](../../core_flows/types/core_flows.ConfirmReturnRequestWorkflowInput/page.mdx)
|
||||
- [CreateApiKeysStepInput](../../core_flows/types/core_flows.CreateApiKeysStepInput/page.mdx)
|
||||
- [CreateApiKeysWorkflowInput](../../core_flows/types/core_flows.CreateApiKeysWorkflowInput/page.mdx)
|
||||
- [CreateApiKeysWorkflowOutput](../../core_flows/types/core_flows.CreateApiKeysWorkflowOutput/page.mdx)
|
||||
- [CreateCampaignsWorkflowInput](../../core_flows/types/core_flows.CreateCampaignsWorkflowInput/page.mdx)
|
||||
- [CreateCartsStepInput](../../core_flows/types/core_flows.CreateCartsStepInput/page.mdx)
|
||||
- [CreateCartWorkflowInput](../../core_flows/types/core_flows.CreateCartWorkflowInput/page.mdx)
|
||||
- [CreateClaimShippingMethodValidationStepInput](../../core_flows/types/core_flows.CreateClaimShippingMethodValidationStepInput/page.mdx)
|
||||
- [CreateClaimShippingMethodWorkflowInput](../../core_flows/types/core_flows.CreateClaimShippingMethodWorkflowInput/page.mdx)
|
||||
- [CreateCollectionsWorkflowInput](../../core_flows/types/core_flows.CreateCollectionsWorkflowInput/page.mdx)
|
||||
- [CreateCompleteReturnValidationStepInput](../../core_flows/types/core_flows.CreateCompleteReturnValidationStepInput/page.mdx)
|
||||
- [CreateCustomerAccountWorkflowInput](../../core_flows/types/core_flows.CreateCustomerAccountWorkflowInput/page.mdx)
|
||||
- [CreateCustomerAddressesStepInput](../../core_flows/types/core_flows.CreateCustomerAddressesStepInput/page.mdx)
|
||||
- [CreateCustomerAddressesWorkflowInput](../../core_flows/types/core_flows.CreateCustomerAddressesWorkflowInput/page.mdx)
|
||||
- [CreateCustomerGroupsStepInput](../../core_flows/types/core_flows.CreateCustomerGroupsStepInput/page.mdx)
|
||||
- [CreateCustomerGroupsWorkflowInput](../../core_flows/types/core_flows.CreateCustomerGroupsWorkflowInput/page.mdx)
|
||||
- [CreateCustomerGroupsWorkflowOutput](../../core_flows/types/core_flows.CreateCustomerGroupsWorkflowOutput/page.mdx)
|
||||
- [CreateCustomersStepInput](../../core_flows/types/core_flows.CreateCustomersStepInput/page.mdx)
|
||||
- [CreateCustomersWorkflowInput](../../core_flows/types/core_flows.CreateCustomersWorkflowInput/page.mdx)
|
||||
- [CreateExchangeShippingMethodValidationStepInput](../../core_flows/types/core_flows.CreateExchangeShippingMethodValidationStepInput/page.mdx)
|
||||
- [CreateExchangeShippingMethodWorkflowInput](../../core_flows/types/core_flows.CreateExchangeShippingMethodWorkflowInput/page.mdx)
|
||||
- [CreateFulfillmentSetsStepInput](../../core_flows/types/core_flows.CreateFulfillmentSetsStepInput/page.mdx)
|
||||
- [CreateFulfillmentValidateOrderStepInput](../../core_flows/types/core_flows.CreateFulfillmentValidateOrderStepInput/page.mdx)
|
||||
- [CreateInventoryItemsStepInput](../../core_flows/types/core_flows.CreateInventoryItemsStepInput/page.mdx)
|
||||
- [CreateInventoryLevelsStepInput](../../core_flows/types/core_flows.CreateInventoryLevelsStepInput/page.mdx)
|
||||
- [CreateOrderClaimItemsFromActionsInput](../../core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx)
|
||||
- [CreateOrderEditShippingMethodValidationStepInput](../../core_flows/types/core_flows.CreateOrderEditShippingMethodValidationStepInput/page.mdx)
|
||||
- [CreateOrderEditShippingMethodWorkflowInput](../../core_flows/types/core_flows.CreateOrderEditShippingMethodWorkflowInput/page.mdx)
|
||||
- [CreateOrderExchangeItemsFromActionsInput](../../core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx)
|
||||
- [CreateOrderFulfillmentWorkflowInput](../../core_flows/types/core_flows.CreateOrderFulfillmentWorkflowInput/page.mdx)
|
||||
- [CreateOrderPaymentCollectionWorkflowInput](../../core_flows/types/core_flows.CreateOrderPaymentCollectionWorkflowInput/page.mdx)
|
||||
- [CreateOrderShipmentWorkflowInput](../../core_flows/types/core_flows.CreateOrderShipmentWorkflowInput/page.mdx)
|
||||
- [CreateOrdersStepInput](../../core_flows/types/core_flows.CreateOrdersStepInput/page.mdx)
|
||||
- [CreateOrderWorkflowInput](../../core_flows/types/core_flows.CreateOrderWorkflowInput/page.mdx)
|
||||
- [CreateOrUpdateOrderPaymentCollectionInput](../../core_flows/types/core_flows.CreateOrUpdateOrderPaymentCollectionInput/page.mdx)
|
||||
- [CreatePaymentCollectionCartStepInput](../../core_flows/types/core_flows.CreatePaymentCollectionCartStepInput/page.mdx)
|
||||
- [CreatePriceListPricesWorkflowInput](../../core_flows/types/core_flows.CreatePriceListPricesWorkflowInput/page.mdx)
|
||||
- [CreatePriceListPricesWorkflowOutput](../../core_flows/types/core_flows.CreatePriceListPricesWorkflowOutput/page.mdx)
|
||||
- [CreatePriceListsWorkflowInput](../../core_flows/types/core_flows.CreatePriceListsWorkflowInput/page.mdx)
|
||||
- [CreatePriceListsWorkflowOutput](../../core_flows/types/core_flows.CreatePriceListsWorkflowOutput/page.mdx)
|
||||
- [CreatePricePreferencesStepInput](../../core_flows/types/core_flows.CreatePricePreferencesStepInput/page.mdx)
|
||||
- [CreatePricePreferencesWorkflowInput](../../core_flows/types/core_flows.CreatePricePreferencesWorkflowInput/page.mdx)
|
||||
- [CreatePriceSetWorkflowInput](../../core_flows/types/core_flows.CreatePriceSetWorkflowInput/page.mdx)
|
||||
- [CreateProductCategoriesStepInput](../../core_flows/types/core_flows.CreateProductCategoriesStepInput/page.mdx)
|
||||
- [CreateProductCategoriesWorkflowOutput](../../core_flows/types/core_flows.CreateProductCategoriesWorkflowOutput/page.mdx)
|
||||
- [CreateProductOptionsWorkflowInput](../../core_flows/types/core_flows.CreateProductOptionsWorkflowInput/page.mdx)
|
||||
- [CreateProductsWorkflowInput](../../core_flows/types/core_flows.CreateProductsWorkflowInput/page.mdx)
|
||||
- [CreateProductTagsWorkflowInput](../../core_flows/types/core_flows.CreateProductTagsWorkflowInput/page.mdx)
|
||||
- [CreateProductTypesWorkflowInput](../../core_flows/types/core_flows.CreateProductTypesWorkflowInput/page.mdx)
|
||||
- [CreateProductVariantsWorkflowInput](../../core_flows/types/core_flows.CreateProductVariantsWorkflowInput/page.mdx)
|
||||
- [CreatePromotionsWorkflowInput](../../core_flows/types/core_flows.CreatePromotionsWorkflowInput/page.mdx)
|
||||
- [CreateRefundReasonStepInput](../../core_flows/types/core_flows.CreateRefundReasonStepInput/page.mdx)
|
||||
- [CreateRefundReasonsWorkflowInput](../../core_flows/types/core_flows.CreateRefundReasonsWorkflowInput/page.mdx)
|
||||
- [CreateReservationsStepInput](../../core_flows/types/core_flows.CreateReservationsStepInput/page.mdx)
|
||||
- [CreateReturnReasonsWorkflowInput](../../core_flows/types/core_flows.CreateReturnReasonsWorkflowInput/page.mdx)
|
||||
- [CreateReturnReasonsWorkflowOutput](../../core_flows/types/core_flows.CreateReturnReasonsWorkflowOutput/page.mdx)
|
||||
- [CreateReturnShippingMethodValidationStepInput](../../core_flows/types/core_flows.CreateReturnShippingMethodValidationStepInput/page.mdx)
|
||||
- [CreateReturnShippingMethodWorkflowInput](../../core_flows/types/core_flows.CreateReturnShippingMethodWorkflowInput/page.mdx)
|
||||
- [CreateSalesChannelsWorkflowInput](../../core_flows/types/core_flows.CreateSalesChannelsWorkflowInput/page.mdx)
|
||||
- [CreateSalesChannelsWorkflowOutput](../../core_flows/types/core_flows.CreateSalesChannelsWorkflowOutput/page.mdx)
|
||||
- [CreateServiceZonesStepInput](../../core_flows/types/core_flows.CreateServiceZonesStepInput/page.mdx)
|
||||
- [CreateServiceZonesWorkflowOutput](../../core_flows/types/core_flows.CreateServiceZonesWorkflowOutput/page.mdx)
|
||||
- [CreateShipmentValidateOrderStepInput](../../core_flows/types/core_flows.CreateShipmentValidateOrderStepInput/page.mdx)
|
||||
- [CreateShippingOptionsPriceSetsStepInput](../../core_flows/types/core_flows.CreateShippingOptionsPriceSetsStepInput/page.mdx)
|
||||
- [CreateShippingOptionsPriceSetsStepOutput](../../core_flows/types/core_flows.CreateShippingOptionsPriceSetsStepOutput/page.mdx)
|
||||
- [CreateShippingOptionsWorkflowInput](../../core_flows/types/core_flows.CreateShippingOptionsWorkflowInput/page.mdx)
|
||||
- [CreateShippingProfilesStepInput](../../core_flows/types/core_flows.CreateShippingProfilesStepInput/page.mdx)
|
||||
- [CreateStockLocationsStepInput](../../core_flows/types/core_flows.CreateStockLocationsStepInput/page.mdx)
|
||||
- [CreateStoresWorkflowInput](../../core_flows/types/core_flows.CreateStoresWorkflowInput/page.mdx)
|
||||
- [CreateStoresWorkflowOutput](../../core_flows/types/core_flows.CreateStoresWorkflowOutput/page.mdx)
|
||||
- [CreateTaxRateRulesWorkflowInput](../../core_flows/types/core_flows.CreateTaxRateRulesWorkflowInput/page.mdx)
|
||||
- [CreateTaxRateRulesWorkflowOutput](../../core_flows/types/core_flows.CreateTaxRateRulesWorkflowOutput/page.mdx)
|
||||
- [CreateTaxRatesWorkflowInput](../../core_flows/types/core_flows.CreateTaxRatesWorkflowInput/page.mdx)
|
||||
- [CreateTaxRatesWorkflowOutput](../../core_flows/types/core_flows.CreateTaxRatesWorkflowOutput/page.mdx)
|
||||
- [CreateTaxRegionsWorkflowInput](../../core_flows/types/core_flows.CreateTaxRegionsWorkflowInput/page.mdx)
|
||||
- [CreateTaxRegionsWorkflowOutput](../../core_flows/types/core_flows.CreateTaxRegionsWorkflowOutput/page.mdx)
|
||||
- [CreateUserAccountWorkflowInput](../../core_flows/types/core_flows.CreateUserAccountWorkflowInput/page.mdx)
|
||||
- [CreateVariantPricingLinkStepInput](../../core_flows/types/core_flows.CreateVariantPricingLinkStepInput/page.mdx)
|
||||
- [DeclineTransferOrderRequestValidationStepInput](../../core_flows/types/core_flows.DeclineTransferOrderRequestValidationStepInput/page.mdx)
|
||||
- [DeleteApiKeysStepInput](../../core_flows/types/core_flows.DeleteApiKeysStepInput/page.mdx)
|
||||
- [DeleteApiKeysWorkflowInput](../../core_flows/types/core_flows.DeleteApiKeysWorkflowInput/page.mdx)
|
||||
- [DeleteCampaignsStepInput](../../core_flows/types/core_flows.DeleteCampaignsStepInput/page.mdx)
|
||||
- [DeleteCampaignsWorkflowInput](../../core_flows/types/core_flows.DeleteCampaignsWorkflowInput/page.mdx)
|
||||
- [DeleteCollectionsStepInput](../../core_flows/types/core_flows.DeleteCollectionsStepInput/page.mdx)
|
||||
- [DeleteCollectionsWorkflowInput](../../core_flows/types/core_flows.DeleteCollectionsWorkflowInput/page.mdx)
|
||||
- [DeleteCustomerAddressesStepInput](../../core_flows/types/core_flows.DeleteCustomerAddressesStepInput/page.mdx)
|
||||
- [DeleteCustomerAddressesWorkflowInput](../../core_flows/types/core_flows.DeleteCustomerAddressesWorkflowInput/page.mdx)
|
||||
- [DeleteCustomerGroupsStepInput](../../core_flows/types/core_flows.DeleteCustomerGroupsStepInput/page.mdx)
|
||||
- [DeleteCustomerGroupsWorkflowInput](../../core_flows/types/core_flows.DeleteCustomerGroupsWorkflowInput/page.mdx)
|
||||
- [DeleteCustomersStepInput](../../core_flows/types/core_flows.DeleteCustomersStepInput/page.mdx)
|
||||
- [DeleteCustomersWorkflowInput](../../core_flows/types/core_flows.DeleteCustomersWorkflowInput/page.mdx)
|
||||
- [DeleteFilesStepInput](../../core_flows/types/core_flows.DeleteFilesStepInput/page.mdx)
|
||||
- [DeleteFilesWorkflowInput](../../core_flows/types/core_flows.DeleteFilesWorkflowInput/page.mdx)
|
||||
- [DeleteFulfillmentSetsStepInput](../../core_flows/types/core_flows.DeleteFulfillmentSetsStepInput/page.mdx)
|
||||
- [DeleteFulfillmentSetsWorkflowInput](../../core_flows/types/core_flows.DeleteFulfillmentSetsWorkflowInput/page.mdx)
|
||||
- [DeleteInventoryItemStepInput](../../core_flows/types/core_flows.DeleteInventoryItemStepInput/page.mdx)
|
||||
- [DeleteInventoryItemWorkflowInput](../../core_flows/types/core_flows.DeleteInventoryItemWorkflowInput/page.mdx)
|
||||
- [DeleteInventoryItemWorkflowOutput](../../core_flows/types/core_flows.DeleteInventoryItemWorkflowOutput/page.mdx)
|
||||
- [DeleteInventoryLevelsStepInput](../../core_flows/types/core_flows.DeleteInventoryLevelsStepInput/page.mdx)
|
||||
- [DeleteInvitesStepInput](../../core_flows/types/core_flows.DeleteInvitesStepInput/page.mdx)
|
||||
- [DeleteLineItemsStepInput](../../core_flows/types/core_flows.DeleteLineItemsStepInput/page.mdx)
|
||||
- [DeleteLineItemsWorkflowInput](../../core_flows/types/core_flows.DeleteLineItemsWorkflowInput/page.mdx)
|
||||
- [DeleteOrderChangeActionsWorkflowInput](../../core_flows/types/core_flows.DeleteOrderChangeActionsWorkflowInput/page.mdx)
|
||||
- [DeleteOrderChangeWorkflowInput](../../core_flows/types/core_flows.DeleteOrderChangeWorkflowInput/page.mdx)
|
||||
- [DeleteOrderClaimsInput](../../core_flows/types/core_flows.DeleteOrderClaimsInput/page.mdx)
|
||||
- [DeleteOrderExchangesInput](../../core_flows/types/core_flows.DeleteOrderExchangesInput/page.mdx)
|
||||
- [DeleteOrderPaymentCollectionsInput](../../core_flows/types/core_flows.DeleteOrderPaymentCollectionsInput/page.mdx)
|
||||
- [DeletePriceListsStepInput](../../core_flows/types/core_flows.DeletePriceListsStepInput/page.mdx)
|
||||
- [DeletePriceListsWorkflowInput](../../core_flows/types/core_flows.DeletePriceListsWorkflowInput/page.mdx)
|
||||
- [DeletePricePreferencesStepInput](../../core_flows/types/core_flows.DeletePricePreferencesStepInput/page.mdx)
|
||||
- [DeletePricePreferencesWorkflowInput](../../core_flows/types/core_flows.DeletePricePreferencesWorkflowInput/page.mdx)
|
||||
- [DeleteProductCategoriesStepInput](../../core_flows/types/core_flows.DeleteProductCategoriesStepInput/page.mdx)
|
||||
- [DeleteProductCategoriesWorkflowInput](../../core_flows/types/core_flows.DeleteProductCategoriesWorkflowInput/page.mdx)
|
||||
- [DeleteProductOptionsStepInput](../../core_flows/types/core_flows.DeleteProductOptionsStepInput/page.mdx)
|
||||
- [DeleteProductOptionsWorkflowInput](../../core_flows/types/core_flows.DeleteProductOptionsWorkflowInput/page.mdx)
|
||||
- [DeleteProductsStepInput](../../core_flows/types/core_flows.DeleteProductsStepInput/page.mdx)
|
||||
- [DeleteProductsWorkflowInput](../../core_flows/types/core_flows.DeleteProductsWorkflowInput/page.mdx)
|
||||
- [DeleteProductTagsStepInput](../../core_flows/types/core_flows.DeleteProductTagsStepInput/page.mdx)
|
||||
- [DeleteProductTagsWorkflowInput](../../core_flows/types/core_flows.DeleteProductTagsWorkflowInput/page.mdx)
|
||||
- [DeleteProductTypesStepInput](../../core_flows/types/core_flows.DeleteProductTypesStepInput/page.mdx)
|
||||
- [DeleteProductTypesWorkflowInput](../../core_flows/types/core_flows.DeleteProductTypesWorkflowInput/page.mdx)
|
||||
- [DeleteProductVariantsStepInput](../../core_flows/types/core_flows.DeleteProductVariantsStepInput/page.mdx)
|
||||
- [DeleteProductVariantsWorkflowInput](../../core_flows/types/core_flows.DeleteProductVariantsWorkflowInput/page.mdx)
|
||||
- [DeletePromotionsStepInput](../../core_flows/types/core_flows.DeletePromotionsStepInput/page.mdx)
|
||||
- [DeletePromotionsWorkflowInput](../../core_flows/types/core_flows.DeletePromotionsWorkflowInput/page.mdx)
|
||||
- [DeleteRefundReasonsStepInput](../../core_flows/types/core_flows.DeleteRefundReasonsStepInput/page.mdx)
|
||||
- [DeleteRefundReasonsWorkflowInput](../../core_flows/types/core_flows.DeleteRefundReasonsWorkflowInput/page.mdx)
|
||||
- [DeleteRegionsStepInput](../../core_flows/types/core_flows.DeleteRegionsStepInput/page.mdx)
|
||||
- [DeleteRegionsWorkflowInput](../../core_flows/types/core_flows.DeleteRegionsWorkflowInput/page.mdx)
|
||||
- [DeleteReservationByLineItemsWorkflowInput](../../core_flows/types/core_flows.DeleteReservationByLineItemsWorkflowInput/page.mdx)
|
||||
- [DeleteReservationsByLineItemsStepInput](../../core_flows/types/core_flows.DeleteReservationsByLineItemsStepInput/page.mdx)
|
||||
- [DeleteReservationsStepInput](../../core_flows/types/core_flows.DeleteReservationsStepInput/page.mdx)
|
||||
- [DeleteReturnReasonStepInput](../../core_flows/types/core_flows.DeleteReturnReasonStepInput/page.mdx)
|
||||
- [DeleteReturnReasonsWorkflowInput](../../core_flows/types/core_flows.DeleteReturnReasonsWorkflowInput/page.mdx)
|
||||
- [DeleteReturnStepInput](../../core_flows/types/core_flows.DeleteReturnStepInput/page.mdx)
|
||||
- [DeleteSalesChannelsStepInput](../../core_flows/types/core_flows.DeleteSalesChannelsStepInput/page.mdx)
|
||||
- [DeleteSalesChannelsWorkflowInput](../../core_flows/types/core_flows.DeleteSalesChannelsWorkflowInput/page.mdx)
|
||||
- [DeleteServiceZonesStepInput](../../core_flows/types/core_flows.DeleteServiceZonesStepInput/page.mdx)
|
||||
- [DeleteServiceZonesWorkflowInput](../../core_flows/types/core_flows.DeleteServiceZonesWorkflowInput/page.mdx)
|
||||
- [DeleteShippingOptionsStepInput](../../core_flows/types/core_flows.DeleteShippingOptionsStepInput/page.mdx)
|
||||
- [DeleteShippingProfilesStepInput](../../core_flows/types/core_flows.DeleteShippingProfilesStepInput/page.mdx)
|
||||
- [DeleteShippingProfilesWorkflowInput](../../core_flows/types/core_flows.DeleteShippingProfilesWorkflowInput/page.mdx)
|
||||
- [DeleteStockLocationsStepInput](../../core_flows/types/core_flows.DeleteStockLocationsStepInput/page.mdx)
|
||||
- [DeleteStoresStepInput](../../core_flows/types/core_flows.DeleteStoresStepInput/page.mdx)
|
||||
- [DeleteStoresWorkflowInput](../../core_flows/types/core_flows.DeleteStoresWorkflowInput/page.mdx)
|
||||
- [DeleteTaxRateRulesStepInput](../../core_flows/types/core_flows.DeleteTaxRateRulesStepInput/page.mdx)
|
||||
- [DeleteTaxRateRulesWorkflowInput](../../core_flows/types/core_flows.DeleteTaxRateRulesWorkflowInput/page.mdx)
|
||||
- [DeleteTaxRatesStepInput](../../core_flows/types/core_flows.DeleteTaxRatesStepInput/page.mdx)
|
||||
- [DeleteTaxRatesWorkflowInput](../../core_flows/types/core_flows.DeleteTaxRatesWorkflowInput/page.mdx)
|
||||
- [DeleteTaxRegionsStepInput](../../core_flows/types/core_flows.DeleteTaxRegionsStepInput/page.mdx)
|
||||
- [DeleteTaxRegionsWorkflowInput](../../core_flows/types/core_flows.DeleteTaxRegionsWorkflowInput/page.mdx)
|
||||
- [DeleteUsersStepInput](../../core_flows/types/core_flows.DeleteUsersStepInput/page.mdx)
|
||||
- [DismissItemReturnRequestValidationStepInput](../../core_flows/types/core_flows.DismissItemReturnRequestValidationStepInput/page.mdx)
|
||||
- [DismissItemReturnRequestWorkflowInput](../../core_flows/types/core_flows.DismissItemReturnRequestWorkflowInput/page.mdx)
|
||||
- [DismissRemoteLinksStepInput](../../core_flows/types/core_flows.DismissRemoteLinksStepInput/page.mdx)
|
||||
- [ExchangeAddNewItemValidationStepInput](../../core_flows/types/core_flows.ExchangeAddNewItemValidationStepInput/page.mdx)
|
||||
- [ExchangeRequestItemReturnValidationStepInput](../../core_flows/types/core_flows.ExchangeRequestItemReturnValidationStepInput/page.mdx)
|
||||
- [FindOneOrAnyRegionStepInput](../../core_flows/types/core_flows.FindOneOrAnyRegionStepInput/page.mdx)
|
||||
- [GenerateProductCsvStepInput](../../core_flows/types/core_flows.GenerateProductCsvStepInput/page.mdx)
|
||||
- [GenerateProductCsvStepOutput](../../core_flows/types/core_flows.GenerateProductCsvStepOutput/page.mdx)
|
||||
- [GetAllProductsStepInput](../../core_flows/types/core_flows.GetAllProductsStepInput/page.mdx)
|
||||
- [GetExistingPriceListsPriceIdsStepInput](../../core_flows/types/core_flows.GetExistingPriceListsPriceIdsStepInput/page.mdx)
|
||||
- [GetExistingPriceListsPriceIdsStepOutput](../../core_flows/types/core_flows.GetExistingPriceListsPriceIdsStepOutput/page.mdx)
|
||||
- [GetOrderDetailWorkflowInput](../../core_flows/types/core_flows.GetOrderDetailWorkflowInput/page.mdx)
|
||||
- [GetOrdersListWorkflowInput](../../core_flows/types/core_flows.GetOrdersListWorkflowInput/page.mdx)
|
||||
- [GetOrdersListWorkflowOutput](../../core_flows/types/core_flows.GetOrdersListWorkflowOutput/page.mdx)
|
||||
- [GetProductsStepInput](../../core_flows/types/core_flows.GetProductsStepInput/page.mdx)
|
||||
- [GetPromotionCodesToApplyStepOutput](../../core_flows/types/core_flows.GetPromotionCodesToApplyStepOutput/page.mdx)
|
||||
- [GetVariantAvailabilityStepInput](../../core_flows/types/core_flows.GetVariantAvailabilityStepInput/page.mdx)
|
||||
- [GroupProductsForBatchStepInput](../../core_flows/types/core_flows.GroupProductsForBatchStepInput/page.mdx)
|
||||
- [GroupProductsForBatchStepOutput](../../core_flows/types/core_flows.GroupProductsForBatchStepOutput/page.mdx)
|
||||
- [LinkCustomerGroupsToCustomerWorkflowInput](../../core_flows/types/core_flows.LinkCustomerGroupsToCustomerWorkflowInput/page.mdx)
|
||||
- [LinkCustomersToCustomerGroupWorkflow](../../core_flows/types/core_flows.LinkCustomersToCustomerGroupWorkflow/page.mdx)
|
||||
- [LinkProductsToSalesChannelWorkflowInput](../../core_flows/types/core_flows.LinkProductsToSalesChannelWorkflowInput/page.mdx)
|
||||
- [LinkSalesChannelsToApiKeyStepInput](../../core_flows/types/core_flows.LinkSalesChannelsToApiKeyStepInput/page.mdx)
|
||||
- [LinkSalesChannelsToApiKeyWorkflowInput](../../core_flows/types/core_flows.LinkSalesChannelsToApiKeyWorkflowInput/page.mdx)
|
||||
- [LinkSalesChannelsToStockLocationWorkflowInput](../../core_flows/types/core_flows.LinkSalesChannelsToStockLocationWorkflowInput/page.mdx)
|
||||
- [ListTaxRateIdsStepInput](../../core_flows/types/core_flows.ListTaxRateIdsStepInput/page.mdx)
|
||||
- [ListTaxRateRuleIdsStepInput](../../core_flows/types/core_flows.ListTaxRateRuleIdsStepInput/page.mdx)
|
||||
- [MarkFulfillmentAsDeliveredInput](../../core_flows/types/core_flows.MarkFulfillmentAsDeliveredInput/page.mdx)
|
||||
- [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)
|
||||
- [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)
|
||||
- [OrderAddLineItemWorkflowOutput](../../core_flows/types/core_flows.OrderAddLineItemWorkflowOutput/page.mdx)
|
||||
- [OrderClaimAddNewItemValidationStepInput](../../core_flows/types/core_flows.OrderClaimAddNewItemValidationStepInput/page.mdx)
|
||||
- [OrderClaimItemValidationStepInput](../../core_flows/types/core_flows.OrderClaimItemValidationStepInput/page.mdx)
|
||||
- [OrderClaimRequestItemReturnValidationStepInput](../../core_flows/types/core_flows.OrderClaimRequestItemReturnValidationStepInput/page.mdx)
|
||||
- [OrderEditAddNewItemValidationStepInput](../../core_flows/types/core_flows.OrderEditAddNewItemValidationStepInput/page.mdx)
|
||||
- [OrderEditRequestWorkflowInput](../../core_flows/types/core_flows.OrderEditRequestWorkflowInput/page.mdx)
|
||||
- [OrderEditUpdateItemQuantityValidationStepInput](../../core_flows/types/core_flows.OrderEditUpdateItemQuantityValidationStepInput/page.mdx)
|
||||
- [OrderFulfillmentDeliverabilityValidationStepInput](../../core_flows/types/core_flows.OrderFulfillmentDeliverabilityValidationStepInput/page.mdx)
|
||||
- [ParseProductCsvStepInput](../../core_flows/types/core_flows.ParseProductCsvStepInput/page.mdx)
|
||||
- [PreviewOrderChangeStepInput](../../core_flows/types/core_flows.PreviewOrderChangeStepInput/page.mdx)
|
||||
- [ReceiveCompleteReturnValidationStepInput](../../core_flows/types/core_flows.ReceiveCompleteReturnValidationStepInput/page.mdx)
|
||||
- [ReceiveItemReturnRequestValidationStepInput](../../core_flows/types/core_flows.ReceiveItemReturnRequestValidationStepInput/page.mdx)
|
||||
- [RefreshCartItemsWorkflowInput](../../core_flows/types/core_flows.RefreshCartItemsWorkflowInput/page.mdx)
|
||||
- [RefreshCartShippingMethodsWorkflowInput](../../core_flows/types/core_flows.RefreshCartShippingMethodsWorkflowInput/page.mdx)
|
||||
- [RefreshInviteTokensStepInput](../../core_flows/types/core_flows.RefreshInviteTokensStepInput/page.mdx)
|
||||
- [RefreshPaymentCollectionForCartWorklowInput](../../core_flows/types/core_flows.RefreshPaymentCollectionForCartWorklowInput/page.mdx)
|
||||
- [RefundPaymentsStepInput](../../core_flows/types/core_flows.RefundPaymentsStepInput/page.mdx)
|
||||
- [RefundPaymentStepInput](../../core_flows/types/core_flows.RefundPaymentStepInput/page.mdx)
|
||||
- [RefundPaymentsWorkflowInput](../../core_flows/types/core_flows.RefundPaymentsWorkflowInput/page.mdx)
|
||||
- [RefundPaymentWorkflowInput](../../core_flows/types/core_flows.RefundPaymentWorkflowInput/page.mdx)
|
||||
- [RegisterOrderChangeStepInput](../../core_flows/types/core_flows.RegisterOrderChangeStepInput/page.mdx)
|
||||
- [RemoveAddItemClaimActionWorkflowInput](../../core_flows/types/core_flows.RemoveAddItemClaimActionWorkflowInput/page.mdx)
|
||||
- [RemoveClaimAddItemActionValidationStepInput](../../core_flows/types/core_flows.RemoveClaimAddItemActionValidationStepInput/page.mdx)
|
||||
- [RemoveClaimItemActionValidationStepInput](../../core_flows/types/core_flows.RemoveClaimItemActionValidationStepInput/page.mdx)
|
||||
- [RemoveClaimShippingMethodValidationStepInput](../../core_flows/types/core_flows.RemoveClaimShippingMethodValidationStepInput/page.mdx)
|
||||
- [RemoveCustomerAccountWorkflowInput](../../core_flows/types/core_flows.RemoveCustomerAccountWorkflowInput/page.mdx)
|
||||
- [RemoveExchangeItemActionValidationStepInput](../../core_flows/types/core_flows.RemoveExchangeItemActionValidationStepInput/page.mdx)
|
||||
- [RemoveExchangeShippingMethodValidationStepInput](../../core_flows/types/core_flows.RemoveExchangeShippingMethodValidationStepInput/page.mdx)
|
||||
- [RemoveItemClaimActionWorkflowInput](../../core_flows/types/core_flows.RemoveItemClaimActionWorkflowInput/page.mdx)
|
||||
- [RemoveItemReceiveReturnActionValidationStepInput](../../core_flows/types/core_flows.RemoveItemReceiveReturnActionValidationStepInput/page.mdx)
|
||||
- [RemoveItemReturnActionValidationStepInput](../../core_flows/types/core_flows.RemoveItemReturnActionValidationStepInput/page.mdx)
|
||||
- [RemoveOrderEditItemActionValidationStepInput](../../core_flows/types/core_flows.RemoveOrderEditItemActionValidationStepInput/page.mdx)
|
||||
- [RemoveOrderEditShippingMethodValidationStepInput](../../core_flows/types/core_flows.RemoveOrderEditShippingMethodValidationStepInput/page.mdx)
|
||||
- [RemovePriceListPricesStepInput](../../core_flows/types/core_flows.RemovePriceListPricesStepInput/page.mdx)
|
||||
- [RemovePriceListPricesWorkflowInput](../../core_flows/types/core_flows.RemovePriceListPricesWorkflowInput/page.mdx)
|
||||
- [RemoveReturnShippingMethodValidationStepInput](../../core_flows/types/core_flows.RemoveReturnShippingMethodValidationStepInput/page.mdx)
|
||||
- [RemoveShippingMethodFromCartStepOutput](../../core_flows/types/core_flows.RemoveShippingMethodFromCartStepOutput/page.mdx)
|
||||
- [RemoveUserAccountWorkflowInput](../../core_flows/types/core_flows.RemoveUserAccountWorkflowInput/page.mdx)
|
||||
- [RequestItemReturnValidationStepInput](../../core_flows/types/core_flows.RequestItemReturnValidationStepInput/page.mdx)
|
||||
- [RequestOrderEditRequestValidationStepInput](../../core_flows/types/core_flows.RequestOrderEditRequestValidationStepInput/page.mdx)
|
||||
- [RequestOrderTransferValidationStepInput](../../core_flows/types/core_flows.RequestOrderTransferValidationStepInput/page.mdx)
|
||||
- [RevokeApiKeysStepInput](../../core_flows/types/core_flows.RevokeApiKeysStepInput/page.mdx)
|
||||
- [RevokeApiKeysWorkflowInput](../../core_flows/types/core_flows.RevokeApiKeysWorkflowInput/page.mdx)
|
||||
- [RevokeApiKeysWorkflowOutput](../../core_flows/types/core_flows.RevokeApiKeysWorkflowOutput/page.mdx)
|
||||
- [SendNotificationsStepInput](../../core_flows/types/core_flows.SendNotificationsStepInput/page.mdx)
|
||||
- [SetAuthAppMetadataStepInput](../../core_flows/types/core_flows.SetAuthAppMetadataStepInput/page.mdx)
|
||||
- [SetShippingOptionsPricesStepInput](../../core_flows/types/core_flows.SetShippingOptionsPricesStepInput/page.mdx)
|
||||
- [SetTaxRatesRulesWorkflowInput](../../core_flows/types/core_flows.SetTaxRatesRulesWorkflowInput/page.mdx)
|
||||
- [ThrowUnlessPaymentCollectionNotePaidInput](../../core_flows/types/core_flows.ThrowUnlessPaymentCollectionNotePaidInput/page.mdx)
|
||||
- [TransferCartCustomerWorkflowInput](../../core_flows/types/core_flows.TransferCartCustomerWorkflowInput/page.mdx)
|
||||
- [UpdateApiKeysStepInput](../../core_flows/types/core_flows.UpdateApiKeysStepInput/page.mdx)
|
||||
- [UpdateApiKeysWorkflowInput](../../core_flows/types/core_flows.UpdateApiKeysWorkflowInput/page.mdx)
|
||||
- [UpdateApiKeysWorkflowOutput](../../core_flows/types/core_flows.UpdateApiKeysWorkflowOutput/page.mdx)
|
||||
- [UpdateCampaignsWorkflowInput](../../core_flows/types/core_flows.UpdateCampaignsWorkflowInput/page.mdx)
|
||||
- [UpdateCartPromotionsWorkflowInput](../../core_flows/types/core_flows.UpdateCartPromotionsWorkflowInput/page.mdx)
|
||||
- [UpdateCartsStepInput](../../core_flows/types/core_flows.UpdateCartsStepInput/page.mdx)
|
||||
- [UpdateCartWorkflowInput](../../core_flows/types/core_flows.UpdateCartWorkflowInput/page.mdx)
|
||||
- [UpdateClaimAddNewItemValidationStepInput](../../core_flows/types/core_flows.UpdateClaimAddNewItemValidationStepInput/page.mdx)
|
||||
- [UpdateClaimItemValidationStepInput](../../core_flows/types/core_flows.UpdateClaimItemValidationStepInput/page.mdx)
|
||||
- [UpdateClaimShippingMethodValidationStepInput](../../core_flows/types/core_flows.UpdateClaimShippingMethodValidationStepInput/page.mdx)
|
||||
- [UpdateCollectionsStepInput](../../core_flows/types/core_flows.UpdateCollectionsStepInput/page.mdx)
|
||||
- [UpdateCollectionsWorkflowInput](../../core_flows/types/core_flows.UpdateCollectionsWorkflowInput/page.mdx)
|
||||
- [UpdateCustomerAddresseStepInput](../../core_flows/types/core_flows.UpdateCustomerAddresseStepInput/page.mdx)
|
||||
- [UpdateCustomerAddressesWorkflowInput](../../core_flows/types/core_flows.UpdateCustomerAddressesWorkflowInput/page.mdx)
|
||||
- [UpdateCustomerGroupStepInput](../../core_flows/types/core_flows.UpdateCustomerGroupStepInput/page.mdx)
|
||||
- [UpdateCustomerGroupsWorkflowInput](../../core_flows/types/core_flows.UpdateCustomerGroupsWorkflowInput/page.mdx)
|
||||
- [UpdateCustomerGroupsWorkflowOutput](../../core_flows/types/core_flows.UpdateCustomerGroupsWorkflowOutput/page.mdx)
|
||||
- [UpdateCustomersStepInput](../../core_flows/types/core_flows.UpdateCustomersStepInput/page.mdx)
|
||||
- [UpdateCustomersWorkflowInput](../../core_flows/types/core_flows.UpdateCustomersWorkflowInput/page.mdx)
|
||||
- [UpdateExchangeAddItemValidationStepInput](../../core_flows/types/core_flows.UpdateExchangeAddItemValidationStepInput/page.mdx)
|
||||
- [UpdateExchangeShippingMethodValidationStepInput](../../core_flows/types/core_flows.UpdateExchangeShippingMethodValidationStepInput/page.mdx)
|
||||
- [UpdateInventoryItemsStepInput](../../core_flows/types/core_flows.UpdateInventoryItemsStepInput/page.mdx)
|
||||
- [UpdateInventoryItemsWorkflowOutput](../../core_flows/types/core_flows.UpdateInventoryItemsWorkflowOutput/page.mdx)
|
||||
- [UpdateInventoryLevelsStepInput](../../core_flows/types/core_flows.UpdateInventoryLevelsStepInput/page.mdx)
|
||||
- [UpdateInventoryLevelsWorkflowOutput](../../core_flows/types/core_flows.UpdateInventoryLevelsWorkflowOutput/page.mdx)
|
||||
- [UpdateOrderChangeActionsStepInput](../../core_flows/types/core_flows.UpdateOrderChangeActionsStepInput/page.mdx)
|
||||
- [UpdateOrderChangesStepInput](../../core_flows/types/core_flows.UpdateOrderChangesStepInput/page.mdx)
|
||||
- [UpdateOrderEditAddItemValidationStepInput](../../core_flows/types/core_flows.UpdateOrderEditAddItemValidationStepInput/page.mdx)
|
||||
- [UpdateOrderEditItemQuantityValidationStepInput](../../core_flows/types/core_flows.UpdateOrderEditItemQuantityValidationStepInput/page.mdx)
|
||||
- [UpdateOrderEditShippingMethodValidationStepInput](../../core_flows/types/core_flows.UpdateOrderEditShippingMethodValidationStepInput/page.mdx)
|
||||
- [UpdateOrderExchangesStepInput](../../core_flows/types/core_flows.UpdateOrderExchangesStepInput/page.mdx)
|
||||
- [UpdateOrderShippingMethodsStepInput](../../core_flows/types/core_flows.UpdateOrderShippingMethodsStepInput/page.mdx)
|
||||
- [UpdateOrdersStepInput](../../core_flows/types/core_flows.UpdateOrdersStepInput/page.mdx)
|
||||
- [UpdateOrderTaxLinesWorkflowInput](../../core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx)
|
||||
- [UpdateOrderValidationStepInput](../../core_flows/types/core_flows.UpdateOrderValidationStepInput/page.mdx)
|
||||
- [UpdatePriceListPricesWorkflowInput](../../core_flows/types/core_flows.UpdatePriceListPricesWorkflowInput/page.mdx)
|
||||
- [UpdatePriceListsStepInput](../../core_flows/types/core_flows.UpdatePriceListsStepInput/page.mdx)
|
||||
- [UpdatePriceListsWorkflowInput](../../core_flows/types/core_flows.UpdatePriceListsWorkflowInput/page.mdx)
|
||||
- [UpdatePricePreferencesAsArrayStepInput](../../core_flows/types/core_flows.UpdatePricePreferencesAsArrayStepInput/page.mdx)
|
||||
- [UpdatePriceSetsStepInput](../../core_flows/types/core_flows.UpdatePriceSetsStepInput/page.mdx)
|
||||
- [UpdateProductCategoriesStepInput](../../core_flows/types/core_flows.UpdateProductCategoriesStepInput/page.mdx)
|
||||
- [UpdateProductCategoriesWorkflowOutput](../../core_flows/types/core_flows.UpdateProductCategoriesWorkflowOutput/page.mdx)
|
||||
- [UpdateProductOptionsStepInput](../../core_flows/types/core_flows.UpdateProductOptionsStepInput/page.mdx)
|
||||
- [UpdateProductOptionsWorkflowInput](../../core_flows/types/core_flows.UpdateProductOptionsWorkflowInput/page.mdx)
|
||||
- [UpdateProductsStepInput](../../core_flows/types/core_flows.UpdateProductsStepInput/page.mdx)
|
||||
@@ -263,21 +516,57 @@ import { TypeList } from "docs-ui"
|
||||
- [UpdateProductVariantsStepInput](../../core_flows/types/core_flows.UpdateProductVariantsStepInput/page.mdx)
|
||||
- [UpdateProductVariantsWorkflowInput](../../core_flows/types/core_flows.UpdateProductVariantsWorkflowInput/page.mdx)
|
||||
- [UpdateProductWorkflowInput](../../core_flows/types/core_flows.UpdateProductWorkflowInput/page.mdx)
|
||||
- [UpdatePromotionsStatusWorkflowInput](../../core_flows/types/core_flows.UpdatePromotionsStatusWorkflowInput/page.mdx)
|
||||
- [UpdatePromotionsWorkflowInput](../../core_flows/types/core_flows.UpdatePromotionsWorkflowInput/page.mdx)
|
||||
- [UpdateReceiveItemReturnRequestValidationStepInput](../../core_flows/types/core_flows.UpdateReceiveItemReturnRequestValidationStepInput/page.mdx)
|
||||
- [UpdateRefundReasonStepInput](../../core_flows/types/core_flows.UpdateRefundReasonStepInput/page.mdx)
|
||||
- [UpdateRefundReasonsWorkflowInput](../../core_flows/types/core_flows.UpdateRefundReasonsWorkflowInput/page.mdx)
|
||||
- [UpdateRefundReasonsWorkflowOutput](../../core_flows/types/core_flows.UpdateRefundReasonsWorkflowOutput/page.mdx)
|
||||
- [UpdateRegionsStepInput](../../core_flows/types/core_flows.UpdateRegionsStepInput/page.mdx)
|
||||
- [UpdateRequestItemReturnValidationStepInput](../../core_flows/types/core_flows.UpdateRequestItemReturnValidationStepInput/page.mdx)
|
||||
- [UpdateReservationsStepInput](../../core_flows/types/core_flows.UpdateReservationsStepInput/page.mdx)
|
||||
- [UpdateReturnItemBySelector](../../core_flows/types/core_flows.UpdateReturnItemBySelector/page.mdx)
|
||||
- [UpdateReturnReasonsWorkflowInput](../../core_flows/types/core_flows.UpdateReturnReasonsWorkflowInput/page.mdx)
|
||||
- [UpdateReturnReasonsWorkflowOutput](../../core_flows/types/core_flows.UpdateReturnReasonsWorkflowOutput/page.mdx)
|
||||
- [UpdateReturnShippingMethodValidationStepInput](../../core_flows/types/core_flows.UpdateReturnShippingMethodValidationStepInput/page.mdx)
|
||||
- [UpdateReturnsStepInput](../../core_flows/types/core_flows.UpdateReturnsStepInput/page.mdx)
|
||||
- [UpdateReturnValidationStepInput](../../core_flows/types/core_flows.UpdateReturnValidationStepInput/page.mdx)
|
||||
- [UpdateSalesChannelsStepInput](../../core_flows/types/core_flows.UpdateSalesChannelsStepInput/page.mdx)
|
||||
- [UpdateSalesChannelsWorkflowInput](../../core_flows/types/core_flows.UpdateSalesChannelsWorkflowInput/page.mdx)
|
||||
- [UpdateSalesChannelsWorkflowOutput](../../core_flows/types/core_flows.UpdateSalesChannelsWorkflowOutput/page.mdx)
|
||||
- [UpdateServiceZonesWorkflowOutput](../../core_flows/types/core_flows.UpdateServiceZonesWorkflowOutput/page.mdx)
|
||||
- [UpdateShippingMethodsStepInput](../../core_flows/types/core_flows.UpdateShippingMethodsStepInput/page.mdx)
|
||||
- [UpdateShippingOptionsWorkflowInput](../../core_flows/types/core_flows.UpdateShippingOptionsWorkflowInput/page.mdx)
|
||||
- [UpdateShippingProfilesStepInput](../../core_flows/types/core_flows.UpdateShippingProfilesStepInput/page.mdx)
|
||||
- [UpdateShippingProfilesWorkflowOutput](../../core_flows/types/core_flows.UpdateShippingProfilesWorkflowOutput/page.mdx)
|
||||
- [UpdateStoresStepInput](../../core_flows/types/core_flows.UpdateStoresStepInput/page.mdx)
|
||||
- [UpdateStoresWorkflowOutput](../../core_flows/types/core_flows.UpdateStoresWorkflowOutput/page.mdx)
|
||||
- [UpdateTaxLinesWorkflowInput](../../core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx)
|
||||
- [UpdateTaxRatesStepInput](../../core_flows/types/core_flows.UpdateTaxRatesStepInput/page.mdx)
|
||||
- [UpdateTaxRatesWorkflowInput](../../core_flows/types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx)
|
||||
- [UpdateTaxRatesWorkflowOutput](../../core_flows/types/core_flows.UpdateTaxRatesWorkflowOutput/page.mdx)
|
||||
- [UpdateTaxRegionsStepInput](../../core_flows/types/core_flows.UpdateTaxRegionsStepInput/page.mdx)
|
||||
- [UpdateTaxRegionsWorkflowInput](../../core_flows/types/core_flows.UpdateTaxRegionsWorkflowInput/page.mdx)
|
||||
- [UpdateTaxRegionsWorkflowOutput](../../core_flows/types/core_flows.UpdateTaxRegionsWorkflowOutput/page.mdx)
|
||||
- [UploadFilesStepInput](../../core_flows/types/core_flows.UploadFilesStepInput/page.mdx)
|
||||
- [UploadFilesWorkflowInput](../../core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx)
|
||||
- [UpsertShippingOptionsStepInput](../../core_flows/types/core_flows.UpsertShippingOptionsStepInput/page.mdx)
|
||||
- [UpsertVariantPricesWorkflowInput](../../core_flows/types/core_flows.UpsertVariantPricesWorkflowInput/page.mdx)
|
||||
- [UseQueryGraphStepInput](../../core_flows/types/core_flows.UseQueryGraphStepInput/page.mdx)
|
||||
- [ValidateCartShippingOptionsPriceInput](../../core_flows/types/core_flows.ValidateCartShippingOptionsPriceInput/page.mdx)
|
||||
- [ValidateExistingPaymentCollectionStepInput](../../core_flows/types/core_flows.ValidateExistingPaymentCollectionStepInput/page.mdx)
|
||||
- [ValidateInventoryItemsForCreateStepInput](../../core_flows/types/core_flows.ValidateInventoryItemsForCreateStepInput/page.mdx)
|
||||
- [ValidateInventoryLevelsDeleteStepInput](../../core_flows/types/core_flows.ValidateInventoryLevelsDeleteStepInput/page.mdx)
|
||||
- [ValidateInventoryLocationsStepInput](../../core_flows/types/core_flows.ValidateInventoryLocationsStepInput/page.mdx)
|
||||
- [ValidatePaymentsRefundStepInput](../../core_flows/types/core_flows.ValidatePaymentsRefundStepInput/page.mdx)
|
||||
- [ValidatePriceListsStepInput](../../core_flows/types/core_flows.ValidatePriceListsStepInput/page.mdx)
|
||||
- [ValidateRefundStepInput](../../core_flows/types/core_flows.ValidateRefundStepInput/page.mdx)
|
||||
- [ValidateShipmentStepInput](../../core_flows/types/core_flows.ValidateShipmentStepInput/page.mdx)
|
||||
- [ValidateShippingMethodsDataInput](../../core_flows/types/core_flows.ValidateShippingMethodsDataInput/page.mdx)
|
||||
- [ValidateShippingMethodsDataOutput](../../core_flows/types/core_flows.ValidateShippingMethodsDataOutput/page.mdx)
|
||||
- [ValidateShippingOptionPricesStepInput](../../core_flows/types/core_flows.ValidateShippingOptionPricesStepInput/page.mdx)
|
||||
- [ValidateTokenStepInput](../../core_flows/types/core_flows.ValidateTokenStepInput/page.mdx)
|
||||
- [ValidateVariantPriceLinksStepInput](../../core_flows/types/core_flows.ValidateVariantPriceLinksStepInput/page.mdx)
|
||||
|
||||
## Functions
|
||||
|
||||
@@ -285,7 +574,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>`","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 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
|
||||
|
||||
@@ -297,13 +586,13 @@ 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>`","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 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"/>
|
||||
|
||||
### campaignsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="campaignsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","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="campaignsCreated"/>
|
||||
|
||||
### campaignsDeleted
|
||||
|
||||
@@ -315,7 +604,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":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="campaignsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","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="campaignsUpdated"/>
|
||||
|
||||
### cartCreated
|
||||
|
||||
@@ -351,7 +640,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":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="customersCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"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="customersCreated"/>
|
||||
|
||||
### customersDeleted
|
||||
|
||||
@@ -369,7 +658,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":"fulfillment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address uLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address uLine truncated
|
||||
|
||||
### orderCanceled
|
||||
|
||||
@@ -381,7 +670,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":"order","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="orderCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"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="orderCreated"/>
|
||||
|
||||
### orderFulfillmentCanceled
|
||||
|
||||
@@ -489,7 +778,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":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="promotionsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","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="promotionsCreated"/>
|
||||
|
||||
### promotionsDeleted
|
||||
|
||||
@@ -497,14 +786,86 @@ 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":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsDeleted"/>
|
||||
|
||||
### promotionStatusUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="promotionStatusUpdated"/>
|
||||
|
||||
### promotionsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`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="promotionsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","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="promotionsUpdated"/>
|
||||
|
||||
### shipmentCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address usedLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address usedLine truncated
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[AddShippingMethodToCartWorkflowInput](../../core_flows/interfaces/core_flows.AddShippingMethodToCartWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[AddToCartWorkflowInputDTO](../../types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CompleteCartWorkflowInput](../../core_flows/types/core_flows.CompleteCartWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"cartInput","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"cartToCreate","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[RefreshPaymentCollectionForCartWorklowInput](../../core_flows/types/core_flows.RefreshPaymentCollectionForCartWorklowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[RefreshCartItemsWorkflowInput](../../core_flows/types/core_flows.RefreshCartItemsWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[RefreshCartShippingMethodsWorkflowInput](../../core_flows/types/core_flows.RefreshCartShippingMethodsWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[TransferCartCustomerWorkflowInput](../../core_flows/types/core_flows.TransferCartCustomerWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"cartInput","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"cartToUpdate","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[UpdateCartPromotionsWorkflowInput](../../core_flows/types/core_flows.UpdateCartPromotionsWorkflowInput/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
|
||||
### validate
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"input","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[UpdateLineItemInCartWorkflowInputDTO](../../types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx)>","description":"This type is used to encapsulate the input or output type of all utils.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
|
||||
Reference in new issue
Block a user