chore(docs): Generated References (automated) (#8532)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-09 11:31:37 +02:00
committed by GitHub
co-authored by kodiakhq
parent f659c6d8bd
commit fdc94f6482
217 changed files with 835367 additions and 228454 deletions
+698 -6
View File
@@ -1887,26 +1887,698 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodTaxLine/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.ShippingMethodTaxLine"
},
{
"filePath": "/www/apps/resources/references/core_flows/core_flows.Steps/page.mdx",
"pathname": "/references/core_flows/core_flows.Steps"
},
{
"filePath": "/www/apps/resources/references/core_flows/core_flows.Workflows/page.mdx",
"pathname": "/references/core_flows/core_flows.Workflows"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.AddShippingMethodToCartStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.AddShippingMethodToCartStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.AddShippingMethodToCartWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.AddShippingMethodToCartWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.AssociateLocationsWithSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.AssociateLocationsWithSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.AssociateProductsWithSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.AssociateProductsWithSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.BulkCreateDeleteLevelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.BulkCreateDeleteLevelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ConfirmVariantInventoryStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ConfirmVariantInventoryStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateDefaultSalesChannelStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateDefaultSalesChannelStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateInventoryItemsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateInventoryItemsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateInventoryLevelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateInventoryLevelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateLineItemAdjustmentsCartStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateLineItemAdjustmentsCartStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateLineItemsCartStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateLineItemsCartStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreatePaymentSessionStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreatePaymentSessionStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreatePaymentSessionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreatePaymentSessionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateShippingMethodAdjustmentsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateShippingMethodAdjustmentsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.CreateStockLocationsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.CreateStockLocationsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.DeleteInventoryLevelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.DeleteInventoryLevelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.DeletePaymentSessionStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.DeletePaymentSessionStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.DeleteStockLocationWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.DeleteStockLocationWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.DetachLocationsFromSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.DetachLocationsFromSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.DetachProductsFromSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.DetachProductsFromSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.EntryStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.EntryStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.FindOrCreateCustomerOutputStepOutput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.FindOrCreateCustomerStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.FindOrCreateCustomerStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.FindSalesChannelStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.FindSalesChannelStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetActionsToComputeFromPromotionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetActionsToComputeFromPromotionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetItemTaxLinesStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetItemTaxLinesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetLineItemActionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetLineItemActionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetPromotionCodesToApplyStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetPromotionCodesToApplyStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetVariantPriceSetsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetVariantPriceSetsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.GetVariantsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.GetVariantsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ListLineItemsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ListLineItemsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ListShippingOptionsForContextStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RefreshCartShippingMethodsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RefreshCartShippingMethodsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RemoteStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RemoteStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RemoveLineItemAdjustmentsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RemoveLineItemAdjustmentsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RemoveShippingMethodAdjustmentsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RemoveShippingMethodAdjustmentsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RemoveShippingMethodFromCartStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RemoveShippingMethodFromCartStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RetrieveCartStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RetrieveCartStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.RetrieveCartWithLinksStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.RetrieveCartWithLinksStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ServiceStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ServiceStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.SetTaxLinesForItemsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ShippingOptionsPriceCurrencyCode/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ShippingOptionsPriceCurrencyCode"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateCartPromotionStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateCartPromotionStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateInventoryItemsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateInventoryItemsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateInventoryLevelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateInventoryLevelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateLineItemsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateLineItemsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdatePaymentCollectionStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdatePaymentCollectionStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateReturnItemBySelector/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateReturnItemBySelector"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.UpdateStockLocationsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.UpdateStockLocationsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateCartPaymentsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateCartPaymentsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateCartShippingOptionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateCartShippingOptionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateSalesChannelsExistStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/interfaces/core_flows.ValidateVariantPricesStepInput/page.mdx",
"pathname": "/references/core_flows/interfaces/core_flows.ValidateVariantPricesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ArchiveOrdersWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ArchiveOrdersWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CancelBeginOrderClaimWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CancelBeginOrderClaimWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CancelBeginOrderExchangeWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CancelBeginOrderExchangeWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CancelPaymentStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CancelPaymentStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CancelRequestReturnWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CancelRequestReturnWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CapturePaymentStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CapturePaymentStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CompleteCartWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CompleteCartWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CompleteOrdersWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CompleteOrdersWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ConfirmClaimRequestWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ConfirmClaimRequestWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ConfirmExchangeRequestWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ConfirmExchangeRequestWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ConfirmReceiveReturnRequestWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ConfirmReceiveReturnRequestWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ConfirmReturnRequestWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ConfirmReturnRequestWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateApiKeysStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateApiKeysStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateApiKeysWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateApiKeysWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCampaignsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCampaignsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCollectionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCollectionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCustomerAccountWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCustomerAccountWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCustomerAddressesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCustomerAddressesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCustomerGroupsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCustomerGroupsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateCustomersWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateCustomersWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreatePriceListsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreatePriceListsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductCategoriesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductCategoriesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductOptionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductTagsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductTagsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductTypesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductTypesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductVariantsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductVariantsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateProductsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateProductsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreatePromotionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreatePromotionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateReturnReasonsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateReturnReasonsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateSalesChannelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateSalesChannelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateShippingOptionsPriceSetsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateShippingOptionsPriceSetsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateTaxRateRulesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateTaxRateRulesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateUserAccountWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateUserAccountWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.CreateVariantPricingLinkStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.CreateVariantPricingLinkStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteApiKeysWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteApiKeysWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteCampaignsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteCampaignsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteCollectionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteCollectionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteCustomerAddressesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteCustomerAddressesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteCustomerGroupsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteCustomerGroupsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteCustomersWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteCustomersWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteFilesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteFilesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteLineItemsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteLineItemsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteProductOptionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteProductOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteProductTagsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteProductTagsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteProductTypesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteProductTypesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteProductVariantsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteProductVariantsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteProductsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteProductsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeletePromotionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeletePromotionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteRegionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteRegionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteReservationByLineItemsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteReservationByLineItemsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteReturnReasonsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteReturnReasonsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteSalesChannelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteSalesChannelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteStoresWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteStoresWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteTaxRateRulesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteTaxRateRulesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteTaxRatesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteTaxRatesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DeleteTaxRegionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DeleteTaxRegionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.DismissRemoteLinksStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.DismissRemoteLinksStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.GetAllProductsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.GetAllProductsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.GetOrdersListWorkflowOutput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.GetOrdersListWorkflowOutput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.GetProductsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.GetProductsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ListTaxRateIdsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ListTaxRateIdsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.ListTaxRateRuleIdsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.ListTaxRateRuleIdsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.MaybeUnsetDefaultBillingAddressStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.MaybeUnsetDefaultBillingAddressStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.MaybeUnsetDefaultShippingAddressesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.MaybeUnsetDefaultShippingAddressesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.RefreshPaymentCollectionForCartWorklowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.RefreshPaymentCollectionForCartWorklowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.RefundPaymentStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.RefundPaymentStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.RevokeApiKeysStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.RevokeApiKeysStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.RevokeApiKeysWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.RevokeApiKeysWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.SetAuthAppMetadataStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.SetAuthAppMetadataStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.SetShippingOptionsPricesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.SetShippingOptionsPricesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.SetTaxRatesRulesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.SetTaxRatesRulesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateApiKeysStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateApiKeysStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateApiKeysWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateApiKeysWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCampaignsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCampaignsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCartPromotionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCartPromotionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCollectionsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCollectionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCollectionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCollectionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomerAddresseStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomerAddresseStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomerAddressesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomerAddressesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomerGroupStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomerGroupStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomerGroupsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomerGroupsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomersStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomersStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateCustomersWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateCustomersWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdatePricePreferencesAsArrayStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdatePricePreferencesAsArrayStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdatePriceSetsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdatePriceSetsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductCategoriesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductCategoriesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductOptionsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductOptionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductOptionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductTagsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductTagsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductTagsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductTagsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductTypesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductTypesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductVariantsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductVariantsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductVariantsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductVariantsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductsWorkflowInputProducts/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductsWorkflowInputProducts"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateProductsWorkflowInputSelector/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateProductsWorkflowInputSelector"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdatePromotionsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdatePromotionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateRegionsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateRegionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateReturnReasonsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateReturnReasonsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateSalesChannelsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateSalesChannelsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateSalesChannelsWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateSalesChannelsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateShippingProfilesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateShippingProfilesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateStoresStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateStoresStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateTaxRatesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateTaxRatesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpdateTaxRatesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UploadFilesStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UploadFilesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpsertShippingOptionsStepInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpsertShippingOptionsStepInput"
},
{
"filePath": "/www/apps/resources/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput/page.mdx",
"pathname": "/references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies"
@@ -5147,10 +5819,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderReturnReasonDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderReturnReasonDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderReturnReasonWithSelectorDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderReturnReasonWithSelectorDTO"
},
{
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderReturnWithSelectorDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderReturnWithSelectorDTO"
@@ -9327,13 +9995,25 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReason/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReason"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonDeleteResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonDeleteResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListParams/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListParams"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonsResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonsResponse"
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnResponse/page.mdx",
@@ -9539,6 +10219,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnItems/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnItems"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnReason/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnReason"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnRequest/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnRequest"
@@ -10207,6 +10891,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseReturnReason/page.mdx",
"pathname": "/references/types/interfaces/types.BaseReturnReason"
},
{
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseReturnReasonListParams/page.mdx",
"pathname": "/references/types/interfaces/types.BaseReturnReasonListParams"
},
{
"filePath": "/www/apps/resources/references/types/interfaces/types.Context/page.mdx",
"pathname": "/references/types/interfaces/types.Context"
@@ -10315,6 +11003,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.AddressDTO/page.mdx",
"pathname": "/references/types/types/types.AddressDTO"
},
{
"filePath": "/www/apps/resources/references/types/types/types.AdminBaseReturnReasonPayload/page.mdx",
"pathname": "/references/types/types/types.AdminBaseReturnReasonPayload"
},
{
"filePath": "/www/apps/resources/references/types/types/types.AdminUpdateFulfillmentSetServiceZoneGeoZone/page.mdx",
"pathname": "/references/types/types/types.AdminUpdateFulfillmentSetServiceZoneGeoZone"
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# AddShippingMethodToCartStepInput
## Properties
<TypeList types={[{"name":"shipping_methods","type":"[CreateShippingMethodDTO](../../../cart/interfaces/cart.CreateShippingMethodDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The associated cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_option_id","type":"`string`","description":"The amount of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateTaxLineDTO](../../../cart/interfaces/cart.CreateTaxLineDTO/page.mdx)[]","description":"The tax lines of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateAdjustmentDTO](../../../cart/interfaces/cart.CreateAdjustmentDTO/page.mdx)[]","description":"The adjustments of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AddShippingMethodToCartStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# AddShippingMethodToCartWorkflowInput
## Properties
<TypeList types={[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AddShippingMethodToCartWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# AssociateLocationsWithSalesChannelsStepInput
## Properties
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channel_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AssociateLocationsWithSalesChannelsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# AssociateProductsWithSalesChannelsStepInput
## Properties
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channel_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AssociateProductsWithSalesChannelsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# BulkCreateDeleteLevelsWorkflowInput
## Properties
<TypeList types={[{"name":"creates","type":"[CreateInventoryLevelInput](../../../types/InventoryTypes/interfaces/types.InventoryTypes.CreateInventoryLevelInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deletes","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="BulkCreateDeleteLevelsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ConfirmVariantInventoryStepInput
## Properties
<TypeList types={[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="ConfirmVariantInventoryStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateDefaultSalesChannelStepInput
## Properties
<TypeList types={[{"name":"data","type":"[CreateSalesChannelDTO](../../../sales_channel/interfaces/sales_channel.CreateSalesChannelDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateDefaultSalesChannelStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateInventoryItemsWorkflowInput
## Properties
<TypeList types={[{"name":"items","type":"[CreateInventoryItemInput](../../../types/InventoryTypes/interfaces/types.InventoryTypes.CreateInventoryItemInput/page.mdx) & `object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The title of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the inventory item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"`LocationLevelWithoutInventory`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateInventoryItemsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateInventoryLevelsWorkflowInput
## Properties
<TypeList types={[{"name":"inventory_levels","type":"[CreateInventoryLevelInput](../../../types/InventoryTypes/interfaces/types.InventoryTypes.CreateInventoryLevelInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateInventoryLevelsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateLineItemAdjustmentsCartStepInput
## Properties
<TypeList types={[{"name":"lineItemAdjustmentsToCreate","type":"[CreateLineItemAdjustmentDTO](../../../cart/interfaces/cart.CreateLineItemAdjustmentDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateLineItemAdjustmentsCartStepInput"/>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateSalesChannelsStepInput
## Properties
<TypeList types={[{"name":"data","type":"[CreateSalesChannelDTO](../../../sales_channel/interfaces/sales_channel.CreateSalesChannelDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateSalesChannelsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateShippingMethodAdjustmentsStepInput
## Properties
<TypeList types={[{"name":"shippingMethodAdjustmentsToCreate","type":"[CreateShippingMethodAdjustmentDTO](../../../cart/interfaces/cart.CreateShippingMethodAdjustmentDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"The description of the shipping method adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateShippingMethodAdjustmentsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# CreateStockLocationsWorkflowInput
## Properties
<TypeList types={[{"name":"locations","type":"[CreateStockLocationInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `null`","description":"The associated address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"`string` \\| [StockLocationAddressInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressInput/page.mdx)","description":"The associated address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateStockLocationsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# DeleteInventoryLevelsWorkflowInput
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteInventoryLevelsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# DeletePaymentSessionStepInput
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeletePaymentSessionStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# DeleteStockLocationWorkflowInput
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteStockLocationWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# DetachLocationsFromSalesChannelsStepInput
## Properties
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channel_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="DetachLocationsFromSalesChannelsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# DetachProductsFromSalesChannelsStepInput
## Properties
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channel_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="DetachProductsFromSalesChannelsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# FindOrCreateCustomerStepInput
## Properties
<TypeList types={[{"name":"customerId","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FindOrCreateCustomerStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# FindSalesChannelStepInput
## Properties
<TypeList types={[{"name":"salesChannelId","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FindSalesChannelStepInput"/>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# GetPromotionCodesToApplyStepInput
## Properties
<TypeList types={[{"name":"cart","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"adjustments","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"adjustments","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"[ADD](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#add) \\| [REMOVE](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#remove) \\| [REPLACE](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#replace)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="GetPromotionCodesToApplyStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# GetVariantPriceSetsStepInput
## Properties
<TypeList types={[{"name":"variantIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="GetVariantPriceSetsStepInput"/>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ListShippingOptionsForContextStepInput
## Properties
<TypeList types={[{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;[ShippingOptionDTO](../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="ListShippingOptionsForContextStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# PrepareAdjustmentsFromPromotionActionsStepInput
## Properties
<TypeList types={[{"name":"actions","type":"[ComputeActions](../../../promotion/types/promotion.ComputeActions/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"addShippingMethodAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeShippingMethodAdjustment\"`","description":"The type of action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"campaignBudgetExceeded\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="PrepareAdjustmentsFromPromotionActionsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# RemoveLineItemAdjustmentsStepInput
## Properties
<TypeList types={[{"name":"lineItemAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RemoveLineItemAdjustmentsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# RemoveShippingMethodAdjustmentsStepInput
## Properties
<TypeList types={[{"name":"shippingMethodAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RemoveShippingMethodAdjustmentsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# RemoveShippingMethodFromCartStepInput
## Properties
<TypeList types={[{"name":"shipping_method_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RemoveShippingMethodFromCartStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# RetrieveCartStepInput
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)&#60;[CartDTO](../../../cart/interfaces/cart.CartDTO/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="RetrieveCartStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# RetrieveCartWithLinksStepInput
## Properties
<TypeList types={[{"name":"cart_or_cart_id","type":"`string` \\| `CartWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RetrieveCartWithLinksStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# SetTaxLinesForItemsStepInput
## Properties
<TypeList types={[{"name":"cart","type":"`CartWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_lines","type":"[ItemTaxLineDTO](../../../tax/interfaces/tax.ItemTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_tax_lines","type":"[ShippingTaxLineDTO](../../../tax/interfaces/tax.ShippingTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_line_id","type":"`string`","description":"The associated shipping line's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="SetTaxLinesForItemsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ShippingOptionsPriceCurrencyCode
## Properties
<TypeList types={[{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ShippingOptionsPriceCurrencyCode"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# UpdateCartPromotionStepInput
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"[ADD](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#add) \\| [REMOVE](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#remove) \\| [REPLACE](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#replace)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateCartPromotionStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# UpdateInventoryItemsWorkflowInput
## Properties
<TypeList types={[{"name":"updates","type":"[UpdateInventoryItemInput](../../../types/InventoryTypes/interfaces/types.InventoryTypes.UpdateInventoryItemInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The title of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS code of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the inventory item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="UpdateInventoryItemsWorkflowInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# UpdateInventoryLevelsWorkflowInput
## Properties
<TypeList types={[{"name":"updates","type":"[BulkUpdateInventoryLevelInput](../../../types/InventoryTypes/interfaces/types.InventoryTypes.BulkUpdateInventoryLevelInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"id of the inventory level to update","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The stocked quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The incoming quantity of the associated inventory item in the associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="UpdateInventoryLevelsWorkflowInput"/>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# UpdateReturnItemBySelector
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateReturnItemBySelector"/>
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ValidateCartPaymentsStepInput
## Properties
<TypeList types={[{"name":"cart","type":"`CartWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ValidateCartPaymentsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ValidateDeletedPaymentSessionsStepInput
## Properties
<TypeList types={[{"name":"idsToDelete","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idsDeleted","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ValidateDeletedPaymentSessionsStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ValidateSalesChannelsExistStepInput
## Properties
<TypeList types={[{"name":"sales_channel_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ValidateSalesChannelsExistStepInput"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# ValidateVariantPricesStepInput
## Properties
<TypeList types={[{"name":"variants","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"calculated_amount","type":"`null` \\| [BigNumberInput](../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="ValidateVariantPricesStepInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ArchiveOrdersWorkflowInput
**ArchiveOrdersWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"orderIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ArchiveOrdersWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CancelBeginOrderClaimWorkflowInput
**CancelBeginOrderClaimWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelBeginOrderClaimWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CancelBeginOrderExchangeWorkflowInput
**CancelBeginOrderExchangeWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelBeginOrderExchangeWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CancelPaymentStepInput
**CancelPaymentStepInput**: `Object`
## Properties
<TypeList types={[{"name":"paymentIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelPaymentStepInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CancelRequestReturnWorkflowInput
**CancelRequestReturnWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CancelRequestReturnWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CapturePaymentStepInput
**CapturePaymentStepInput**: `Object`
## Properties
<TypeList types={[{"name":"payment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CapturePaymentStepInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CompleteCartWorkflowInput
**CompleteCartWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CompleteCartWorkflowInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CompleteOrdersWorkflowInput
**CompleteOrdersWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ConfirmClaimRequestWorkflowInput
**ConfirmClaimRequestWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ConfirmClaimRequestWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ConfirmExchangeRequestWorkflowInput
**ConfirmExchangeRequestWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ConfirmExchangeRequestWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ConfirmReceiveReturnRequestWorkflowInput
**ConfirmReceiveReturnRequestWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ConfirmReceiveReturnRequestWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ConfirmReturnRequestWorkflowInput
**ConfirmReturnRequestWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ConfirmReturnRequestWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateApiKeysStepInput
**CreateApiKeysStepInput**: `Object`
## Properties
<TypeList types={[{"name":"api_keys","type":"[CreateApiKeyDTO](../../../api_key/interfaces/api_key.CreateApiKeyDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateApiKeysStepInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateApiKeysWorkflowInput
**CreateApiKeysWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"api_keys","type":"[CreateApiKeyDTO](../../../api_key/interfaces/api_key.CreateApiKeyDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateApiKeysWorkflowInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateCampaignsWorkflowInput
**CreateCampaignsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateCollectionsWorkflowInput
**CreateCollectionsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateCustomerAccountWorkflowInput
**CreateCustomerAccountWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"authIdentityId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customersData","type":"[CreateCustomerDTO](../../../customer/interfaces/customer.CreateCustomerDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"Omit&#60;[CreateCustomerAddressDTO](../../../customer/interfaces/customer.CreateCustomerAddressDTO/page.mdx), \"customer_id\"&#62;[]","description":"The addresses of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is default shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateCustomerAccountWorkflowInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateCustomerAddressesWorkflowInput
**CreateCustomerAddressesWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateCustomerGroupsWorkflowInput
**CreateCustomerGroupsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"customersData","type":"[CreateCustomerGroupDTO](../../../customer/interfaces/customer.CreateCustomerGroupDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the customer group. For example,\nthe ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateCustomerGroupsWorkflowInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateCustomersWorkflowInput
**CreateCustomersWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
File diff suppressed because one or more lines are too long
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreatePriceListsWorkflowInput
**CreatePriceListsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"price_lists_data","type":"`CreatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePriceListsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateProductCategoriesStepInput
**CreateProductCategoriesStepInput**: `Object`
## Properties
<TypeList types={[{"name":"product_categories","type":"[CreateProductCategoryDTO](../../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The product category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent product category, if it has any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateProductCategoriesStepInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateProductOptionsWorkflowInput
**CreateProductOptionsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateProductTagsWorkflowInput
**CreateProductTagsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateProductTypesWorkflowInput
**CreateProductTypesWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateProductVariantsWorkflowInput
**CreateProductVariantsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateProductsWorkflowInput
**CreateProductsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreatePromotionsWorkflowInput
**CreatePromotionsWorkflowInput**: `object` & [AdditionalData](../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateReturnReasonsWorkflowInput
**CreateReturnReasonsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"data","type":"[CreateOrderReturnReasonDTO](../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The associated parent return reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateReturnReasonsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateSalesChannelsWorkflowInput
**CreateSalesChannelsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"salesChannelsData","type":"[CreateSalesChannelDTO](../../../sales_channel/interfaces/sales_channel.CreateSalesChannelDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateSalesChannelsWorkflowInput"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# CreateShippingOptionsPriceSetsStepInput
**CreateShippingOptionsPriceSetsStepInput**: `object`[]
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateTaxRateRulesWorkflowInput
**CreateTaxRateRulesWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"rules","type":"[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateTaxRateRulesWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateUserAccountWorkflowInput
**CreateUserAccountWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"authIdentityId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"userData","type":"[CreateUserDTO](../../../user/interfaces/user.CreateUserDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The email of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the user.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the user.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"avatar_url","type":"`null` \\| `string`","description":"The avatar URL of the user.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateUserAccountWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# CreateVariantPricingLinkStepInput
**CreateVariantPricingLinkStepInput**: `Object`
## Properties
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreateVariantPricingLinkStepInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteApiKeysWorkflowInput
**DeleteApiKeysWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteApiKeysWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteCampaignsWorkflowInput
**DeleteCampaignsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteCampaignsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteCollectionsWorkflowInput
**DeleteCollectionsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteCollectionsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteCustomerAddressesWorkflowInput
**DeleteCustomerAddressesWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteCustomerAddressesWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteCustomerGroupsWorkflowInput
**DeleteCustomerGroupsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteCustomerGroupsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteCustomersWorkflowInput
**DeleteCustomersWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteCustomersWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteFilesWorkflowInput
**DeleteFilesWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteFilesWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# DeleteLineItemsWorkflowInput
**DeleteLineItemsWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DeleteLineItemsWorkflowInput"/>

Some files were not shown because too many files have changed in this diff Show More