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

docs: generate references manually for v2.1.2 (#10639)

Browse Source 
* docs: manually generate references for v2.1.2

* more changes
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-17 19:20:44 +02:00
1 parent ee62083c52
commit 0f5d640736
196 files changed
+267336 -200539
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/generated/edit-dates.mjs
+116 -79
View File
@@ -247,7 +247,7 @@ export const generatedEditDates = {
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemWorkflow/page.mdx": "2024-08-20T00:10:59.105Z",
"references/core_flows/core_flows.Order/page.mdx": "2024-08-20T00:10:56.437Z",
"references/modules/core_flows/page.mdx": "2024-12-09T13:21:37.177Z",
"references/types/types.HttpTypes/page.mdx": "2024-12-10T14:54:55.617Z",
"references/types/types.HttpTypes/page.mdx": "2024-12-17T16:57:20.068Z",
"app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2024-08-23T11:31:26.346Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx": "2024-12-09T13:21:36.285Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.deleteProviderIdentities/page.mdx": "2024-12-09T13:21:36.293Z",
@@ -280,7 +280,7 @@ export const generatedEditDates = {
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentStep/page.mdx": "2024-12-10T14:54:58.517Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createReturnFulfillmentStep/page.mdx": "2024-12-10T14:54:58.535Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.updateFulfillmentStep/page.mdx": "2024-12-10T14:54:58.553Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.upsertShippingOptionsStep/page.mdx": "2024-12-10T14:54:58.560Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.upsertShippingOptionsStep/page.mdx": "2024-12-17T16:57:22.224Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createFulfillmentWorkflow/page.mdx": "2024-12-10T14:54:58.574Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createReturnFulfillmentWorkflow/page.mdx": "2024-12-10T14:54:58.584Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx": "2024-12-10T14:54:58.595Z",
@@ -598,10 +598,10 @@ export const generatedEditDates = {
"references/order_models/classes/order_models.OrderTransaction/page.mdx": "2024-12-09T13:22:00.812Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx": "2024-12-09T13:21:33.353Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReservation/page.mdx": "2024-12-09T13:21:34.501Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.Attachment/page.mdx": "2024-12-09T13:21:35.425Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.Attachment/page.mdx": "2024-12-17T16:57:21.128Z",
"references/modules/fulfillment_models/page.mdx": "2024-11-25T17:49:50.572Z",
"references/modules/order_models/page.mdx": "2024-11-25T17:49:55.360Z",
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2024-12-09T13:22:00.412Z",
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2024-12-17T16:57:27.196Z",
"references/order/interfaces/order.IOrderModuleService/page.mdx": "2024-12-04T18:29:33.901Z",
"references/order_models/classes/order_models.OrderItem/page.mdx": "2024-12-09T13:22:00.632Z",
"references/order_models/classes/order_models.OrderSummary/page.mdx": "2024-12-09T13:22:00.676Z",
@@ -610,10 +610,10 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryListResponse/page.mdx": "2024-12-09T13:21:34.221Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryResponse/page.mdx": "2024-12-09T13:21:34.217Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReservationResponse/page.mdx": "2024-12-09T13:21:34.509Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationModuleService/page.mdx": "2024-12-09T13:21:35.465Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationProvider/page.mdx": "2024-12-09T13:21:35.445Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO/page.mdx": "2024-12-09T13:21:35.425Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.ProviderSendNotificationDTO/page.mdx": "2024-12-09T13:21:35.441Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationModuleService/page.mdx": "2024-12-17T16:57:21.150Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationProvider/page.mdx": "2024-12-17T16:57:21.140Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO/page.mdx": "2024-12-17T16:57:21.129Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.ProviderSendNotificationDTO/page.mdx": "2024-12-17T16:57:21.138Z",
"references/types/interfaces/types.BaseProductCategory/page.mdx": "2024-12-09T13:21:34.929Z",
"references/types/types.NotificationTypes/page.mdx": "2024-11-25T17:49:28.027Z",
"app/medusa-cli/commands/db/page.mdx": "2024-08-28T11:26:33.889Z",
@@ -649,7 +649,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/types/types.HttpTypes.TransactionState/page.mdx": "2024-08-30T00:11:02.502Z",
"references/types/HttpTypes/types/types.HttpTypes.TransactionStepState/page.mdx": "2024-08-30T00:11:02.502Z",
"references/types/HttpTypes/types/types.HttpTypes.TransactionStepStatus/page.mdx": "2024-08-30T00:11:02.498Z",
"references/types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx": "2024-12-09T13:21:32.793Z",
"references/types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx": "2024-12-17T16:57:19.829Z",
"references/types/interfaces/types.AdminWorkflowExecutionExecution/page.mdx": "2024-12-09T13:21:35.017Z",
"references/types/interfaces/types.BaseCustomerGroup/page.mdx": "2024-12-09T13:21:33.237Z",
"references/types/interfaces/types.BatchPriceListPricesWorkflowDTO/page.mdx": "2024-12-09T13:21:35.477Z",
@@ -670,7 +670,7 @@ export const generatedEditDates = {
"references/types/interfaces/types.OrderWorkflowDTO/page.mdx": "2024-12-09T13:21:35.469Z",
"references/types/interfaces/types.PricedShippingOptionDTO/page.mdx": "2024-12-09T13:21:32.813Z",
"references/types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx": "2024-12-09T13:21:32.797Z",
"references/types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx": "2024-12-09T13:21:32.785Z",
"references/types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx": "2024-12-17T16:57:19.825Z",
"references/types/interfaces/types.UpdatePriceListPriceWorkflowDTO/page.mdx": "2024-12-09T13:21:35.473Z",
"references/types/interfaces/types.UpdatePriceListPriceWorkflowStepDTO/page.mdx": "2024-12-09T13:21:35.485Z",
"references/types/interfaces/types.UpdatePriceListPricesWorkflowDTO/page.mdx": "2024-12-09T13:21:35.477Z",
@@ -684,13 +684,13 @@ export const generatedEditDates = {
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.setTaxLinesForItemsStep/page.mdx": "2024-12-10T14:54:57.994Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartsStep/page.mdx": "2024-12-10T14:54:58.001Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartPaymentsStep/page.mdx": "2024-12-10T14:54:58.011Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx": "2024-12-10T14:54:58.023Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx": "2024-12-17T16:57:22.017Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx": "2024-12-10T14:54:58.025Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx": "2024-12-10T14:54:58.043Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx": "2024-12-10T14:54:58.050Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx": "2024-12-10T14:54:58.052Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx": "2024-12-10T14:54:58.058Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx": "2024-12-10T14:54:58.069Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx": "2024-12-17T16:57:22.057Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx": "2024-12-10T14:54:58.078Z",
"references/core_flows/Cart/core_flows.Cart.Steps_Cart/page.mdx": "2024-12-09T13:21:37.269Z",
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx": "2024-12-10T14:54:58.303Z",
@@ -737,7 +737,7 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx": "2024-12-09T13:21:54.280Z",
"references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx": "2024-12-09T13:21:50.208Z",
"references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx": "2024-12-10T14:55:09.195Z",
"references/modules/types/page.mdx": "2024-12-10T14:54:55.301Z",
"references/modules/types/page.mdx": "2024-12-17T16:57:19.815Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx": "2024-12-09T13:22:02.112Z",
"references/order/interfaces/order.CancelOrderClaimDTO/page.mdx": "2024-12-09T13:22:01.392Z",
"references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx": "2024-12-09T13:22:01.396Z",
@@ -779,7 +779,7 @@ export const generatedEditDates = {
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx": "2024-12-10T14:54:58.017Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx": "2024-12-10T14:54:58.049Z",
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx": "2024-12-10T14:54:58.333Z",
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx": "2024-12-10T14:54:58.353Z",
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx": "2024-12-17T16:57:22.110Z",
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx": "2024-12-10T14:54:58.355Z",
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx": "2024-12-10T14:54:58.357Z",
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx": "2024-12-10T14:54:58.369Z",
@@ -1020,7 +1020,6 @@ export const generatedEditDates = {
"references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listAndCountCustomerAddresses/page.mdx": "2024-12-09T13:21:55.344Z",
"references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.listCustomerAddresses/page.mdx": "2024-12-09T13:21:55.336Z",
"references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.updateCustomerAddresses/page.mdx": "2024-12-09T13:21:55.316Z",
"references/customer_models/classes/customer_models.CustomerAddress/page.mdx": "2024-12-09T13:21:55.156Z",
"references/modules_sdk/classes/modules_sdk.Query/page.mdx": "2024-12-09T13:22:00.392Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.registerDelivery/page.mdx": "2024-12-09T13:22:02.096Z",
"references/order/interfaces/order.RegisterOrderDeliveryDTO/page.mdx": "2024-12-09T13:22:01.340Z",
@@ -1204,10 +1203,7 @@ export const generatedEditDates = {
"references/customer/interfaces/customer.JoinerServiceConfig/page.mdx": "2024-12-09T13:21:55.412Z",
"references/customer/interfaces/customer.JoinerServiceConfigAlias/page.mdx": "2024-12-09T13:21:55.412Z",
"references/customer/types/customer.JoinerRelationship/page.mdx": "2024-12-09T13:21:55.408Z",
"references/customer_models/classes/customer_models.Customer/page.mdx": "2024-12-09T13:21:55.172Z",
"references/customer_models/classes/customer_models.CustomerGroup/page.mdx": "2024-12-09T13:21:55.164Z",
"references/customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx": "2024-12-09T13:21:55.160Z",
"references/dml/Model_Methods/methods/dml.Model_Methods.cascades/page.mdx": "2024-12-10T14:55:08.595Z",
"references/dml/Model_Methods/methods/dml.Model_Methods.cascades/page.mdx": "2024-12-17T16:57:24.851Z",
"references/dml/Property_Types/methods/dml.Property_Types.enum/page.mdx": "2024-12-10T14:55:08.588Z",
"references/dml/Property_Types/methods/dml.Property_Types.id/page.mdx": "2024-12-10T14:55:08.583Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.belongsTo/page.mdx": "2024-12-10T14:55:08.592Z",
@@ -1279,7 +1275,7 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx": "2024-12-09T13:21:56.352Z",
"references/fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx": "2024-12-09T13:21:56.324Z",
"references/fulfillment/types/fulfillment.JoinerRelationship/page.mdx": "2024-12-09T13:21:56.268Z",
"references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx": "2024-12-09T13:21:55.644Z",
"references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx": "2024-12-17T16:57:24.913Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory/page.mdx": "2024-12-09T13:21:56.800Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.confirmInventory/page.mdx": "2024-12-09T13:21:56.804Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.createInventoryItems/page.mdx": "2024-12-09T13:21:56.744Z",
@@ -1321,7 +1317,7 @@ export const generatedEditDates = {
"references/inventory_next/interfaces/inventory_next.JoinerServiceConfigAlias/page.mdx": "2024-12-09T13:21:56.816Z",
"references/inventory_next/types/inventory_next.JoinerRelationship/page.mdx": "2024-12-09T13:21:56.812Z",
"references/modules/api_key/page.mdx": "2024-11-27T16:33:40.668Z",
"references/modules/customer_models/page.mdx": "2024-11-25T17:49:50.228Z",
"references/modules/customer_models/page.mdx": "2024-12-17T16:57:24.660Z",
"references/modules/order/page.mdx": "2024-12-04T18:29:33.622Z",
"references/modules/utils/page.mdx": "2024-12-10T14:54:57.100Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.applyPendingOrderActions/page.mdx": "2024-12-09T13:22:01.800Z",
@@ -1403,7 +1399,7 @@ export const generatedEditDates = {
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentProviders/page.mdx": "2024-12-09T13:22:02.572Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentSessions/page.mdx": "2024-12-09T13:22:02.536Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPayments/page.mdx": "2024-12-09T13:22:02.540Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefundReasons/page.mdx": "2024-12-09T13:22:02.604Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefundReasons/page.mdx": "2024-12-17T16:57:28.210Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefunds/page.mdx": "2024-12-09T13:22:02.584Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.refundPayment/page.mdx": "2024-12-09T13:22:02.560Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.restoreRefundReasons/page.mdx": "2024-12-09T13:22:02.596Z",
@@ -1740,7 +1736,7 @@ export const generatedEditDates = {
"references/types/types/types.RawBigNumberPrefix-1/page.mdx": "2024-09-23T00:11:34.851Z",
"references/types/types/types.Scalars-1/page.mdx": "2024-12-09T13:21:35.241Z",
"references/types/types/types.TypeOnly-2/page.mdx": "2024-12-09T13:21:35.421Z",
"references/medusa/interfaces/medusa.MedusaRequest/page.mdx": "2024-12-09T13:21:32.693Z",
"references/medusa/interfaces/medusa.MedusaRequest/page.mdx": "2024-12-17T16:57:19.787Z",
"references/medusa/types/medusa.MedusaContainer-2/page.mdx": "2024-09-24T00:11:41.170Z",
"references/medusa/types/medusa.MedusaErrorHandlerFunction/page.mdx": "2024-12-09T13:21:32.681Z",
"references/medusa/types/medusa.MedusaRequestHandler/page.mdx": "2024-12-09T13:21:32.701Z",
@@ -1824,19 +1820,19 @@ export const generatedEditDates = {
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteFulfillmentSetsStep/page.mdx": "2024-12-10T14:54:58.541Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteServiceZonesStep/page.mdx": "2024-12-10T14:54:58.542Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionsStep/page.mdx": "2024-12-10T14:54:58.543Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.setShippingOptionsPricesStep/page.mdx": "2024-12-10T14:54:58.544Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.setShippingOptionsPricesStep/page.mdx": "2024-12-17T16:57:22.210Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.updateShippingProfilesStep/page.mdx": "2024-12-10T14:54:58.556Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.validateShipmentStep/page.mdx": "2024-12-10T14:54:58.560Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx": "2024-12-10T14:54:58.563Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx": "2024-12-10T14:54:58.564Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createServiceZonesWorkflow/page.mdx": "2024-12-10T14:54:58.587Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx": "2024-12-10T14:54:58.605Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx": "2024-12-17T16:57:22.263Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingProfilesWorkflow/page.mdx": "2024-12-10T14:54:58.609Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteFulfillmentSetsWorkflow/page.mdx": "2024-12-10T14:54:58.610Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx": "2024-12-10T14:54:58.611Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx": "2024-12-10T14:54:58.611Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx": "2024-12-10T14:54:58.642Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx": "2024-12-10T14:54:58.644Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx": "2024-12-17T16:57:22.297Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx": "2024-12-10T14:54:58.650Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.adjustInventoryLevelsStep/page.mdx": "2024-12-10T14:54:58.824Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.attachInventoryItemToVariants/page.mdx": "2024-12-10T14:54:58.824Z",
@@ -2099,7 +2095,7 @@ export const generatedEditDates = {
"references/inventory_next/interfaces/inventory_next.FilterableReservationItemProps/page.mdx": "2024-12-09T13:21:56.684Z",
"references/inventory_next/interfaces/inventory_next.IModuleService/page.mdx": "2024-12-09T13:21:56.828Z",
"references/inventory_next/interfaces/inventory_next.MessageAggregatorFormat/page.mdx": "2024-12-09T13:21:56.832Z",
"references/modules/fulfillment/page.mdx": "2024-11-27T16:33:52.453Z",
"references/modules/fulfillment/page.mdx": "2024-12-17T16:57:24.915Z",
"references/order/IMessageAggregator/methods/order.IMessageAggregator.getMessages/page.mdx": "2024-12-09T13:22:02.156Z",
"references/order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx": "2024-12-09T13:22:01.336Z",
"references/order/interfaces/order.IModuleService/page.mdx": "2024-12-09T13:22:00.856Z",
@@ -2151,9 +2147,6 @@ export const generatedEditDates = {
"references/tax/IMessageAggregator/methods/tax.IMessageAggregator.getMessages/page.mdx": "2024-12-09T13:22:04.516Z",
"references/tax/interfaces/tax.IModuleService/page.mdx": "2024-12-09T13:22:04.508Z",
"references/tax/interfaces/tax.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.512Z",
"references/tax_models/classes/tax_models.TaxRate/page.mdx": "2024-12-09T13:22:04.444Z",
"references/tax_models/classes/tax_models.TaxRateRule/page.mdx": "2024-12-09T13:22:04.436Z",
"references/tax_models/classes/tax_models.TaxRegion/page.mdx": "2024-12-09T13:22:04.456Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateReturnReason/page.mdx": "2024-12-09T13:21:34.517Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRate/page.mdx": "2024-12-09T13:21:34.697Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRegion/page.mdx": "2024-12-09T13:21:34.713Z",
@@ -2237,9 +2230,9 @@ export const generatedEditDates = {
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx": "2024-12-09T13:21:35.373Z",
"references/user/interfaces/user.FindConfig/page.mdx": "2024-12-09T13:22:04.684Z",
"references/workflows/types/workflows.StepFunction/page.mdx": "2024-12-09T13:22:04.832Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx": "2024-12-10T14:54:58.020Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx": "2024-12-17T16:57:22.014Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx": "2024-12-09T13:21:56.260Z",
"references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx": "2024-11-25T17:49:50.968Z",
"references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx": "2024-12-17T16:57:25.097Z",
"references/types/CommonTypes/interfaces/types.CommonTypes.RequestQueryFields/page.mdx": "2024-12-09T13:21:32.865Z",
"references/utils/utils.ProductUtils/page.mdx": "2024-12-10T14:54:57.156Z",
"app/commerce-modules/region/links-to-other-modules/page.mdx": "2024-10-15T14:10:50.853Z",
@@ -2869,8 +2862,8 @@ export const generatedEditDates = {
"references/medusa/types/medusa.ClassConstructor/page.mdx": "2024-12-09T13:21:32.729Z",
"references/medusa/types/medusa.Constructor/page.mdx": "2024-12-09T13:21:32.733Z",
"references/medusa/types/medusa.MedusaContainer/page.mdx": "2024-12-09T13:21:32.709Z",
"references/modules/inventory_next_models/page.mdx": "2024-10-23T07:15:53.084Z",
"references/modules/stock_location_next_models/page.mdx": "2024-11-25T17:49:58.944Z",
"references/modules/inventory_next_models/page.mdx": "2024-12-17T16:57:25.408Z",
"references/modules/stock_location_next_models/page.mdx": "2024-12-17T16:57:28.948Z",
"references/modules/tax/page.mdx": "2024-11-27T16:33:56.766Z",
"references/modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx": "2024-12-09T13:22:00.340Z",
"references/modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx": "2024-12-09T13:22:00.344Z",
@@ -3215,7 +3208,7 @@ export const generatedEditDates = {
"references/types/types/types.PrevLimit/page.mdx": "2024-11-06T21:08:40.426Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateProductVariant/page.mdx": "2024-12-09T13:21:34.321Z",
"references/types/types/types.PluralizationSpecialRules/page.mdx": "2024-12-09T13:21:32.837Z",
"references/types/types/types.UncountableRules/page.mdx": "2024-11-12T09:36:21.340Z",
"references/types/types/types.UncountableRules/page.mdx": "2024-12-17T16:57:19.850Z",
"references/product/interfaces/product.FilterableProductProps/page.mdx": "2024-12-09T13:22:03.256Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z",
"references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2024-12-09T13:21:35.797Z",
@@ -3258,11 +3251,11 @@ export const generatedEditDates = {
"references/cart/interfaces/cart.IMessageAggregator/page.mdx": "2024-11-25T17:49:29.499Z",
"references/currency/interfaces/currency.IMessageAggregator/page.mdx": "2024-11-25T17:49:50.216Z",
"references/customer/interfaces/customer.IMessageAggregator/page.mdx": "2024-11-25T17:49:50.492Z",
"references/dml/dml.Property_Configuration_Methods/page.mdx": "2024-12-10T14:55:08.597Z",
"references/dml/dml.Property_Types/page.mdx": "2024-12-10T14:55:08.582Z",
"references/dml/dml.Property_Configuration_Methods/page.mdx": "2024-12-17T16:57:24.853Z",
"references/dml/dml.Property_Types/page.mdx": "2024-12-17T16:57:24.838Z",
"references/dml/dml.Relationship_Methods/page.mdx": "2024-12-10T14:55:08.590Z",
"references/dml/entity_builder/classes/dml.entity_builder.EntityBuilder/page.mdx": "2024-12-10T14:55:08.571Z",
"references/dml/properties_base/classes/dml.properties_base.BaseProperty/page.mdx": "2024-12-09T13:21:55.468Z",
"references/dml/entity_builder/classes/dml.entity_builder.EntityBuilder/page.mdx": "2024-12-17T16:57:24.827Z",
"references/dml/properties_base/classes/dml.properties_base.BaseProperty/page.mdx": "2024-12-17T16:57:24.837Z",
"references/fulfillment/interfaces/fulfillment.IBigNumber/page.mdx": "2024-12-09T13:21:56.576Z",
"references/fulfillment/interfaces/fulfillment.IMessageAggregator/page.mdx": "2024-11-25T17:49:51.580Z",
"references/inventory_next/interfaces/inventory_next.IBigNumber/page.mdx": "2024-12-09T13:21:56.844Z",
@@ -3274,17 +3267,17 @@ export const generatedEditDates = {
"references/modules/dml/page.mdx": "2024-12-10T14:55:08.564Z",
"references/modules/inventory_next/page.mdx": "2024-11-27T16:33:52.948Z",
"references/modules/medusa_config/page.mdx": "2024-11-25T17:49:55.224Z",
"references/modules/payment_models/page.mdx": "2024-11-25T17:49:57.100Z",
"references/modules/payment_models/page.mdx": "2024-12-17T16:57:28.003Z",
"references/modules/pricing/page.mdx": "2024-12-04T18:29:34.516Z",
"references/modules/pricing_models/page.mdx": "2024-12-04T18:29:34.496Z",
"references/modules/product_models/page.mdx": "2024-12-04T18:29:34.662Z",
"references/modules/promotion_models/page.mdx": "2024-11-25T17:49:58.440Z",
"references/modules/promotion_models/page.mdx": "2024-12-17T16:57:28.690Z",
"references/modules/region/page.mdx": "2024-11-27T16:33:56.472Z",
"references/modules/sales_channel/page.mdx": "2024-11-25T17:49:58.852Z",
"references/modules/stock_location_next/page.mdx": "2024-11-27T16:33:56.591Z",
"references/modules/store/page.mdx": "2024-12-10T14:55:13.386Z",
"references/modules/store_models/page.mdx": "2024-12-10T14:55:13.379Z",
"references/modules/tax_models/page.mdx": "2024-11-25T17:49:59.256Z",
"references/modules/tax_models/page.mdx": "2024-12-17T16:57:29.102Z",
"references/modules/tax_provider/page.mdx": "2024-11-25T17:49:59.280Z",
"references/modules/user/page.mdx": "2024-11-25T17:49:59.504Z",
"references/order/interfaces/order.IBigNumber/page.mdx": "2024-12-09T13:22:02.164Z",
@@ -3314,7 +3307,7 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.IBigNumber/page.mdx": "2024-12-09T13:22:04.668Z",
"references/tax/interfaces/tax.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.336Z",
"references/tax/interfaces/tax.TaxCalculationContext/page.mdx": "2024-12-09T13:22:04.564Z",
"references/types/DmlTypes/types/types.DmlTypes.PropertyMetadata/page.mdx": "2024-12-10T14:54:55.436Z",
"references/types/DmlTypes/types/types.DmlTypes.PropertyMetadata/page.mdx": "2024-12-17T16:57:19.924Z",
"references/types/DmlTypes/types/types.DmlTypes.RelationshipMetadata/page.mdx": "2024-12-10T14:54:55.439Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductRequest/page.mdx": "2024-12-09T13:21:34.305Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantInventoryItemRequest/page.mdx": "2024-12-09T13:21:34.309Z",
@@ -3343,7 +3336,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTag/page.mdx": "2024-12-09T13:21:34.253Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductType/page.mdx": "2024-12-09T13:21:34.277Z",
"references/types/WorkflowTypes/types.WorkflowTypes.CartWorkflow/page.mdx": "2024-11-25T17:49:28.199Z",
"references/types/WorkflowTypes/types.WorkflowTypes.FulfillmentWorkflow/page.mdx": "2024-11-25T17:49:28.211Z",
"references/types/WorkflowTypes/types.WorkflowTypes.FulfillmentWorkflow/page.mdx": "2024-12-17T16:57:21.218Z",
"references/types/WorkflowTypes/types.WorkflowTypes.OrderWorkflow/page.mdx": "2024-12-04T18:29:19.635Z",
"references/types/WorkflowTypes/types.WorkflowTypes.PriceListWorkflow/page.mdx": "2024-11-25T17:49:28.355Z",
"references/types/WorkflowTypes/types.WorkflowTypes.ProductCategoryWorkflow/page.mdx": "2024-11-25T17:49:28.375Z",
@@ -3452,7 +3445,6 @@ export const generatedEditDates = {
"references/order/interfaces/order.CreateOrderChangeActionDTO/page.mdx": "2024-12-09T13:22:01.316Z",
"references/types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx": "2024-12-10T14:54:55.454Z",
"references/types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx": "2024-12-09T13:21:33.021Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx": "2024-12-09T13:21:35.637Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.transferCartCustomerWorkflow/page.mdx": "2024-12-10T14:54:58.054Z",
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.validatePresenceOfStep/page.mdx": "2024-12-10T14:54:58.303Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.buildPriceSet/page.mdx": "2024-12-10T14:54:58.496Z",
@@ -4829,13 +4821,10 @@ export const generatedEditDates = {
"references/inventory_next/interfaces/inventory_next.StringComparisonOperator/page.mdx": "2024-12-09T13:21:56.640Z",
"references/inventory_next/interfaces/inventory_next.UpdateInventoryItemInput/page.mdx": "2024-12-09T13:21:56.684Z",
"references/inventory_next/interfaces/inventory_next.UpdateReservationItemInput/page.mdx": "2024-12-09T13:21:56.692Z",
"references/inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx": "2024-12-09T13:21:56.620Z",
"references/inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx": "2024-12-09T13:21:56.628Z",
"references/inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx": "2024-12-09T13:21:56.632Z",
"references/medusa/interfaces/medusa.SubscriberContext/page.mdx": "2024-12-09T13:21:32.733Z",
"references/medusa/types/medusa.Event/page.mdx": "2024-12-09T13:21:32.721Z",
"references/medusa/types/medusa.MedusaContainer-1/page.mdx": "2024-12-09T13:21:32.717Z",
"references/medusa/types/medusa.MedusaPricingContext/page.mdx": "2024-12-09T13:21:32.725Z",
"references/medusa/types/medusa.MedusaPricingContext/page.mdx": "2024-12-17T16:57:19.802Z",
"references/medusa/types/medusa.MedusaResponse/page.mdx": "2024-12-09T13:21:32.697Z",
"references/medusa/types/medusa.MiddlewareRoute/page.mdx": "2024-12-09T13:21:32.685Z",
"references/medusa/types/medusa.MiddlewaresConfig/page.mdx": "2024-12-09T13:21:32.689Z",
@@ -4924,7 +4913,7 @@ export const generatedEditDates = {
"references/payment/interfaces/payment.CustomerDTO/page.mdx": "2024-12-09T13:22:02.280Z",
"references/payment/interfaces/payment.FilterablePaymentProps/page.mdx": "2024-12-09T13:22:02.384Z",
"references/payment/interfaces/payment.FilterablePaymentSessionProps/page.mdx": "2024-12-09T13:22:02.352Z",
"references/payment/interfaces/payment.FilterableRefundReasonProps/page.mdx": "2024-12-09T13:22:02.416Z",
"references/payment/interfaces/payment.FilterableRefundReasonProps/page.mdx": "2024-12-17T16:57:28.121Z",
"references/payment/interfaces/payment.PaymentCollectionUpdatableFields/page.mdx": "2024-12-09T13:22:02.424Z",
"references/payment/interfaces/payment.PaymentModuleOptions/page.mdx": "2024-12-09T13:22:02.608Z",
"references/payment/interfaces/payment.PaymentProviderContext/page.mdx": "2024-12-09T13:22:02.448Z",
@@ -4936,14 +4925,6 @@ export const generatedEditDates = {
"references/payment/interfaces/payment.UpdatePaymentSessionDTO/page.mdx": "2024-12-09T13:22:02.436Z",
"references/payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx": "2024-12-09T13:22:02.444Z",
"references/payment/interfaces/payment.UpsertPaymentCollectionDTO/page.mdx": "2024-12-09T13:22:02.420Z",
"references/payment_models/classes/payment_models.Capture/page.mdx": "2024-12-09T13:22:02.184Z",
"references/payment_models/classes/payment_models.Payment/page.mdx": "2024-12-09T13:22:02.236Z",
"references/payment_models/classes/payment_models.PaymentCollection/page.mdx": "2024-12-09T13:22:02.196Z",
"references/payment_models/classes/payment_models.PaymentMethodToken/page.mdx": "2024-12-09T13:22:02.200Z",
"references/payment_models/classes/payment_models.PaymentProvider/page.mdx": "2024-12-09T13:22:02.200Z",
"references/payment_models/classes/payment_models.PaymentSession/page.mdx": "2024-12-09T13:22:02.216Z",
"references/payment_models/classes/payment_models.Refund/page.mdx": "2024-12-09T13:22:02.244Z",
"references/payment_models/classes/payment_models.RefundReason/page.mdx": "2024-12-09T13:22:02.236Z",
"references/pricing/IBigNumber/methods/pricing.IBigNumber.toJSON/page.mdx": "2024-12-09T13:22:02.980Z",
"references/pricing/IBigNumber/methods/pricing.IBigNumber.valueOf/page.mdx": "2024-12-09T13:22:02.980Z",
"references/pricing/IMessageAggregator/methods/pricing.IMessageAggregator.clearMessages/page.mdx": "2024-12-09T13:22:02.972Z",
@@ -5060,12 +5041,6 @@ export const generatedEditDates = {
"references/promotion/interfaces/promotion.UpdateCampaignBudgetDTO/page.mdx": "2024-12-09T13:22:03.776Z",
"references/promotion/interfaces/promotion.UpdateCampaignDTO/page.mdx": "2024-12-09T13:22:03.780Z",
"references/promotion/interfaces/promotion.UpdatePromotionRuleDTO/page.mdx": "2024-12-09T13:22:03.760Z",
"references/promotion_models/classes/promotion_models.ApplicationMethod/page.mdx": "2024-12-09T13:22:03.620Z",
"references/promotion_models/classes/promotion_models.Campaign/page.mdx": "2024-12-09T13:22:03.632Z",
"references/promotion_models/classes/promotion_models.CampaignBudget/page.mdx": "2024-12-09T13:22:03.624Z",
"references/promotion_models/classes/promotion_models.Promotion/page.mdx": "2024-12-09T13:22:03.672Z",
"references/promotion_models/classes/promotion_models.PromotionRule/page.mdx": "2024-12-09T13:22:03.656Z",
"references/promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx": "2024-12-09T13:22:03.640Z",
"references/region/IMessageAggregator/methods/region.IMessageAggregator.clearMessages/page.mdx": "2024-12-09T13:22:04.024Z",
"references/region/IMessageAggregator/methods/region.IMessageAggregator.save/page.mdx": "2024-12-09T13:22:04.020Z",
"references/region/IMessageAggregator/methods/region.IMessageAggregator.saveRawMessageData/page.mdx": "2024-12-09T13:22:04.024Z",
@@ -5101,8 +5076,6 @@ export const generatedEditDates = {
"references/stock_location_next/interfaces/stock_location_next.RestoreReturn/page.mdx": "2024-12-09T13:22:04.140Z",
"references/stock_location_next/interfaces/stock_location_next.SoftDeleteReturn/page.mdx": "2024-12-09T13:22:04.140Z",
"references/stock_location_next/interfaces/stock_location_next.UpsertStockLocationInput/page.mdx": "2024-12-09T13:22:04.296Z",
"references/stock_location_next_models/classes/stock_location_next_models.StockLocation/page.mdx": "2024-12-09T13:22:04.132Z",
"references/stock_location_next_models/classes/stock_location_next_models.StockLocationAddress/page.mdx": "2024-12-09T13:22:04.128Z",
"references/store/IMessageAggregator/methods/store.IMessageAggregator.clearMessages/page.mdx": "2024-12-09T13:22:04.380Z",
"references/store/IMessageAggregator/methods/store.IMessageAggregator.save/page.mdx": "2024-12-09T13:22:04.376Z",
"references/store/IMessageAggregator/methods/store.IMessageAggregator.saveRawMessageData/page.mdx": "2024-12-09T13:22:04.384Z",
@@ -5136,7 +5109,6 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.TaxRegionDTO/page.mdx": "2024-12-09T13:22:04.536Z",
"references/tax/interfaces/tax.TaxableShippingDTO/page.mdx": "2024-12-09T13:22:04.560Z",
"references/tax/interfaces/tax.UpsertTaxRateDTO/page.mdx": "2024-12-09T13:22:04.572Z",
"references/tax_models/classes/tax_models.TaxProvider/page.mdx": "2024-12-09T13:22:04.432Z",
"references/types/CacheTypes/interfaces/types.CacheTypes.ICacheService/page.mdx": "2024-12-09T13:21:32.757Z",
"references/types/CommonTypes/interfaces/types.CommonTypes.BaseEntity/page.mdx": "2024-12-09T13:21:32.857Z",
"references/types/CommonTypes/interfaces/types.CommonTypes.DateComparisonOperator/page.mdx": "2024-12-09T13:21:32.869Z",
@@ -5167,7 +5139,7 @@ export const generatedEditDates = {
"references/types/DAL/types/types.DAL.OperatorMap/page.mdx": "2024-12-09T13:21:32.953Z",
"references/types/DAL/types/types.DAL.PerformedActions/page.mdx": "2024-12-09T13:21:32.913Z",
"references/types/DmlTypes/interfaces/types.DmlTypes.EntityConstructor/page.mdx": "2024-12-09T13:21:33.001Z",
"references/types/DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx": "2024-12-09T13:21:33.017Z",
"references/types/DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx": "2024-12-17T16:57:19.936Z",
"references/types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations/page.mdx": "2024-12-09T13:21:33.013Z",
"references/types/DmlTypes/types/types.DmlTypes.Infer/page.mdx": "2024-12-09T13:21:33.013Z",
"references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx": "2024-12-09T13:21:33.005Z",
@@ -5197,7 +5169,7 @@ export const generatedEditDates = {
"references/types/FileTypes/interfaces/types.FileTypes.ProviderFileResultDTO/page.mdx": "2024-12-09T13:21:33.093Z",
"references/types/FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO/page.mdx": "2024-12-09T13:21:33.097Z",
"references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx": "2024-12-09T13:21:33.101Z",
"references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx": "2024-12-09T13:21:33.109Z",
"references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx": "2024-12-17T16:57:19.969Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItem/page.mdx": "2024-12-09T13:21:34.541Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItems/page.mdx": "2024-12-09T13:21:34.541Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminApiKeyResponse/page.mdx": "2024-12-09T13:21:33.341Z",
@@ -5403,7 +5375,6 @@ export const generatedEditDates = {
"references/types/WorkflowTypes/CommonWorkflow/interfaces/types.WorkflowTypes.CommonWorkflow.WorkflowInputConfig/page.mdx": "2024-12-09T13:21:35.605Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateServiceZonesWorkflowInput/page.mdx": "2024-12-09T13:21:35.625Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShipmentWorkflowInput/page.mdx": "2024-12-09T13:21:35.617Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx": "2024-12-09T13:21:35.617Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingProfilesWorkflowInput/page.mdx": "2024-12-09T13:21:35.629Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.DeleteShippingOptionsWorkflowInput/page.mdx": "2024-12-09T13:21:35.621Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateFulfillmentWorkflowInput/page.mdx": "2024-12-09T13:21:35.637Z",
@@ -5651,13 +5622,13 @@ export const generatedEditDates = {
"references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx": "2024-12-10T14:54:57.622Z",
"references/cart/interfaces/cart.UpdateShippingMethodDTO/page.mdx": "2024-12-10T14:54:57.530Z",
"references/cart_models/variables/cart_models.Address/page.mdx": "2024-12-10T14:54:57.369Z",
"references/cart_models/variables/cart_models.Cart/page.mdx": "2024-12-10T14:54:57.380Z",
"references/cart_models/variables/cart_models.LineItem/page.mdx": "2024-12-10T14:54:57.406Z",
"references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2024-12-10T14:54:57.387Z",
"references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2024-12-10T14:54:57.393Z",
"references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2024-12-10T14:54:57.425Z",
"references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2024-12-10T14:54:57.411Z",
"references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2024-12-10T14:54:57.415Z",
"references/cart_models/variables/cart_models.Cart/page.mdx": "2024-12-17T16:57:21.590Z",
"references/cart_models/variables/cart_models.LineItem/page.mdx": "2024-12-17T16:57:21.609Z",
"references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2024-12-17T16:57:21.595Z",
"references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2024-12-17T16:57:21.599Z",
"references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2024-12-17T16:57:21.624Z",
"references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2024-12-17T16:57:21.613Z",
"references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2024-12-17T16:57:21.616Z",
"references/dml/Property/methods/dml.Property.autoincrement/page.mdx": "2024-12-10T14:55:08.589Z",
"references/dml/dml.Property/page.mdx": "2024-12-10T14:55:08.588Z",
"references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx": "2024-12-10T14:55:13.207Z",
@@ -5685,9 +5656,75 @@ export const generatedEditDates = {
"references/dml/dml.Model_Methods/page.mdx": "2024-12-10T14:55:08.594Z",
"references/modules/api_key_models/page.mdx": "2024-12-10T14:54:57.177Z",
"references/modules/sales_channel_models/page.mdx": "2024-12-10T14:55:13.205Z",
"references/types/DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx": "2024-12-10T14:54:55.434Z",
"references/types/DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx": "2024-12-17T16:57:19.922Z",
"references/types/DmlTypes/types/types.DmlTypes.RelationshipTypes/page.mdx": "2024-12-10T14:54:55.435Z",
"app/recipes/commerce-automation/restock-notification/page.mdx": "2024-12-11T08:47:27.471Z",
"app/troubleshooting/workflow-errors/page.mdx": "2024-12-11T08:44:36.598Z",
"app/nextjs-starter/guides/customize-stripe/page.mdx": "2024-12-12T12:46:33.999Z"
"app/nextjs-starter/guides/customize-stripe/page.mdx": "2024-12-12T12:46:33.999Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx": "2024-12-17T16:57:22.046Z",
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId/page.mdx": "2024-12-17T16:57:22.044Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx": "2024-12-17T16:57:22.227Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId/page.mdx": "2024-12-17T16:57:22.226Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx": "2024-12-17T16:57:22.303Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId/page.mdx": "2024-12-17T16:57:22.302Z",
"references/customer_models/variables/customer_models.Customer/page.mdx": "2024-12-17T16:57:24.675Z",
"references/customer_models/variables/customer_models.CustomerAddress/page.mdx": "2024-12-17T16:57:24.664Z",
"references/customer_models/variables/customer_models.CustomerGroup/page.mdx": "2024-12-17T16:57:24.671Z",
"references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx": "2024-12-17T16:57:24.667Z",
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx": "2024-12-17T16:57:24.854Z",
"references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx": "2024-12-17T16:57:24.842Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx": "2024-12-17T16:57:25.259Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx": "2024-12-17T16:57:25.241Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx": "2024-12-17T16:57:25.257Z",
"references/fulfillment/interfaces/fulfillment.AdjustmentLineDTO/page.mdx": "2024-12-17T16:57:24.916Z",
"references/fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx": "2024-12-17T16:57:25.093Z",
"references/fulfillment/interfaces/fulfillment.CartAddressDTO/page.mdx": "2024-12-17T16:57:24.933Z",
"references/fulfillment/interfaces/fulfillment.CartDTO/page.mdx": "2024-12-17T16:57:24.957Z",
"references/fulfillment/interfaces/fulfillment.CartLineItemDTO/page.mdx": "2024-12-17T16:57:24.948Z",
"references/fulfillment/interfaces/fulfillment.CartLineItemTotalsDTO/page.mdx": "2024-12-17T16:57:24.939Z",
"references/fulfillment/interfaces/fulfillment.CartShippingMethodDTO/page.mdx": "2024-12-17T16:57:24.936Z",
"references/fulfillment/interfaces/fulfillment.LineItemAdjustmentDTO/page.mdx": "2024-12-17T16:57:24.924Z",
"references/fulfillment/interfaces/fulfillment.LineItemTaxLineDTO/page.mdx": "2024-12-17T16:57:24.932Z",
"references/fulfillment/interfaces/fulfillment.ShippingMethodAdjustmentDTO/page.mdx": "2024-12-17T16:57:24.918Z",
"references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx": "2024-12-17T16:57:24.927Z",
"references/fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx": "2024-12-17T16:57:24.925Z",
"references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx": "2024-12-17T16:57:25.096Z",
"references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx": "2024-12-17T16:57:25.413Z",
"references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx": "2024-12-17T16:57:25.416Z",
"references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx": "2024-12-17T16:57:25.420Z",
"references/payment_models/variables/payment_models.Capture/page.mdx": "2024-12-17T16:57:28.008Z",
"references/payment_models/variables/payment_models.Payment/page.mdx": "2024-12-17T16:57:28.033Z",
"references/payment_models/variables/payment_models.PaymentCollection/page.mdx": "2024-12-17T16:57:28.014Z",
"references/payment_models/variables/payment_models.PaymentMethodToken/page.mdx": "2024-12-17T16:57:28.015Z",
"references/payment_models/variables/payment_models.PaymentProvider/page.mdx": "2024-12-17T16:57:28.018Z",
"references/payment_models/variables/payment_models.PaymentSession/page.mdx": "2024-12-17T16:57:28.024Z",
"references/payment_models/variables/payment_models.Refund/page.mdx": "2024-12-17T16:57:28.040Z",
"references/payment_models/variables/payment_models.RefundReason/page.mdx": "2024-12-17T16:57:28.036Z",
"references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx": "2024-12-17T16:57:28.698Z",
"references/promotion_models/variables/promotion_models.Campaign/page.mdx": "2024-12-17T16:57:28.704Z",
"references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx": "2024-12-17T16:57:28.700Z",
"references/promotion_models/variables/promotion_models.Promotion/page.mdx": "2024-12-17T16:57:28.721Z",
"references/promotion_models/variables/promotion_models.PromotionRule/page.mdx": "2024-12-17T16:57:28.715Z",
"references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx": "2024-12-17T16:57:28.707Z",
"references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx": "2024-12-17T16:57:28.952Z",
"references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx": "2024-12-17T16:57:28.950Z",
"references/tax_models/variables/tax_models.TaxProvider/page.mdx": "2024-12-17T16:57:29.104Z",
"references/tax_models/variables/tax_models.TaxRate/page.mdx": "2024-12-17T16:57:29.109Z",
"references/tax_models/variables/tax_models.TaxRateRule/page.mdx": "2024-12-17T16:57:29.106Z",
"references/tax_models/variables/tax_models.TaxRegion/page.mdx": "2024-12-17T16:57:29.113Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionResponse/page.mdx": "2024-12-17T16:57:20.748Z",
"references/types/HttpTypes/types/types.HttpTypes.StoreCalculateShippingOptionPrice/page.mdx": "2024-12-17T16:57:20.745Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput/page.mdx": "2024-12-17T16:57:21.219Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowOutput/page.mdx": "2024-12-17T16:57:21.219Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx": "2024-12-17T16:57:21.225Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput/page.mdx": "2024-12-17T16:57:21.233Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput/page.mdx": "2024-12-17T16:57:21.234Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx": "2024-12-17T16:57:21.233Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx": "2024-12-17T16:57:21.234Z",
"references/types/types/types.CreateCalculatedShippingOptionInput/page.mdx": "2024-12-17T16:57:21.208Z",
"references/types/types/types.CreateFlatRateShippingOptionInput/page.mdx": "2024-12-17T16:57:21.208Z",
"references/types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx": "2024-12-17T16:57:21.206Z",
"references/types/types/types.CreateFlatShippingOptionInputBase/page.mdx": "2024-12-17T16:57:21.207Z",
"references/types/types/types.UpdateFlatShippingOptionInputBase/page.mdx": "2024-12-17T16:57:21.212Z",
"references/core_flows/types/core_flows.UpsertShippingOptionsStepInput/page.mdx": "2024-12-17T16:57:24.521Z"
}
www/apps/resources/generated/files-map.mjs
+206 -62
View File
@@ -2391,6 +2391,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow"
},
{
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow"
},
{
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow"
@@ -2451,6 +2455,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflowId/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflowId"
},
{
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId"
},
{
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflowId/page.mdx",
"pathname": "/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflowId"
@@ -2875,6 +2883,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.buildPriceSet/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.buildPriceSet"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep"
@@ -2943,6 +2955,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.validateShipmentStep/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.validateShipmentStep"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStepId/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStepId"
@@ -3015,6 +3031,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow"
@@ -3083,6 +3103,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflowId/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflowId"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId"
},
{
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflowId/page.mdx",
"pathname": "/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflowId"
@@ -7708,20 +7732,20 @@ export const filesMap = [
"pathname": "/references/customer/types/customer.Scalar"
},
{
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.Customer/page.mdx",
"pathname": "/references/customer_models/classes/customer_models.Customer"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.Customer/page.mdx",
"pathname": "/references/customer_models/variables/customer_models.Customer"
},
{
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerAddress/page.mdx",
"pathname": "/references/customer_models/classes/customer_models.CustomerAddress"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerAddress/page.mdx",
"pathname": "/references/customer_models/variables/customer_models.CustomerAddress"
},
{
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerGroup/page.mdx",
"pathname": "/references/customer_models/classes/customer_models.CustomerGroup"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerGroup/page.mdx",
"pathname": "/references/customer_models/variables/customer_models.CustomerGroup"
},
{
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx",
"pathname": "/references/customer_models/classes/customer_models.CustomerGroupCustomer"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx",
"pathname": "/references/customer_models/variables/customer_models.CustomerGroupCustomer"
},
{
"filePath": "/www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.cascades/page.mdx",
@@ -7735,6 +7759,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/Property/methods/dml.Property.autoincrement/page.mdx",
"pathname": "/references/dml/Property/methods/dml.Property.autoincrement"
},
{
"filePath": "/www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx",
"pathname": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed"
},
{
"filePath": "/www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx",
"pathname": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default"
@@ -7771,6 +7799,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.enum/page.mdx",
"pathname": "/references/dml/Property_Types/methods/dml.Property_Types.enum"
},
{
"filePath": "/www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx",
"pathname": "/references/dml/Property_Types/methods/dml.Property_Types.float"
},
{
"filePath": "/www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.id/page.mdx",
"pathname": "/references/dml/Property_Types/methods/dml.Property_Types.id"
@@ -7891,6 +7923,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/IBigNumber/methods/fulfillment.IBigNumber.valueOf/page.mdx",
"pathname": "/references/fulfillment/IBigNumber/methods/fulfillment.IBigNumber.valueOf"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment"
@@ -7927,6 +7963,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets"
@@ -8155,6 +8195,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx",
"pathname": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IMessageAggregator/methods/fulfillment.IMessageAggregator.clearMessages/page.mdx",
"pathname": "/references/fulfillment/IMessageAggregator/methods/fulfillment.IMessageAggregator.clearMessages"
@@ -8175,10 +8219,38 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/IModuleService/methods/fulfillment.IModuleService.__joinerConfig/page.mdx",
"pathname": "/references/fulfillment/IModuleService/methods/fulfillment.IModuleService.__joinerConfig"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.AdjustmentLineDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.AdjustmentLineDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.BaseFilterable"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CartAddressDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CartAddressDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CartDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CartDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CartLineItemDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CartLineItemDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CartLineItemTotalsDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CartLineItemTotalsDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.CartShippingMethodDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.CartShippingMethodDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.Context/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.Context"
@@ -8339,6 +8411,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.JoinerServiceConfigAlias/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.JoinerServiceConfigAlias"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.LineItemAdjustmentDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.LineItemAdjustmentDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.LineItemTaxLineDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.LineItemTaxLineDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.MessageAggregatorFormat/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.MessageAggregatorFormat"
@@ -8431,6 +8511,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.ServiceZoneDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingMethodAdjustmentDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.ShippingMethodAdjustmentDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.ShippingOptionDTO"
@@ -8451,6 +8539,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.SoftDeleteReturn/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.SoftDeleteReturn"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.TaxLineDTO"
},
{
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.UpdateCityGeoZoneDTO/page.mdx",
"pathname": "/references/fulfillment/interfaces/fulfillment.UpdateCityGeoZoneDTO"
@@ -8515,6 +8607,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.BigNumberValue/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.BigNumberValue"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice"
},
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.ChangeActionType/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.ChangeActionType"
@@ -9144,16 +9240,16 @@ export const filesMap = [
"pathname": "/references/inventory_next/types/inventory_next.Scalar"
},
{
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx",
"pathname": "/references/inventory_next_models/classes/inventory_next_models.InventoryItem"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx",
"pathname": "/references/inventory_next_models/variables/inventory_next_models.InventoryItem"
},
{
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx",
"pathname": "/references/inventory_next_models/classes/inventory_next_models.InventoryLevel"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx",
"pathname": "/references/inventory_next_models/variables/inventory_next_models.InventoryLevel"
},
{
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx",
"pathname": "/references/inventory_next_models/classes/inventory_next_models.ReservationItem"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx",
"pathname": "/references/inventory_next_models/variables/inventory_next_models.ReservationItem"
},
{
"filePath": "/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx",
@@ -13040,36 +13136,36 @@ export const filesMap = [
"pathname": "/references/payment/types/payment.Scalar"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Capture/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.Capture"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Capture/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.Capture"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Payment/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.Payment"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Payment/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.Payment"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentCollection/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.PaymentCollection"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentCollection/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.PaymentCollection"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentMethodToken/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.PaymentMethodToken"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentMethodToken/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.PaymentMethodToken"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentProvider/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.PaymentProvider"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentProvider/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.PaymentProvider"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentSession/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.PaymentSession"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentSession/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.PaymentSession"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Refund/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.Refund"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Refund/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.Refund"
},
{
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.RefundReason/page.mdx",
"pathname": "/references/payment_models/classes/payment_models.RefundReason"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.RefundReason/page.mdx",
"pathname": "/references/payment_models/variables/payment_models.RefundReason"
},
{
"filePath": "/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx",
@@ -14700,28 +14796,28 @@ export const filesMap = [
"pathname": "/references/promotion/types/promotion.UsageComputedActions"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.ApplicationMethod/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.ApplicationMethod"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.ApplicationMethod"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.Campaign/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.Campaign"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.Campaign/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.Campaign"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.CampaignBudget/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.CampaignBudget"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.CampaignBudget"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.Promotion/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.Promotion"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.Promotion/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.Promotion"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRule/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.PromotionRule"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.PromotionRule/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.PromotionRule"
},
{
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx",
"pathname": "/references/promotion_models/classes/promotion_models.PromotionRuleValue"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx",
"pathname": "/references/promotion_models/variables/promotion_models.PromotionRuleValue"
},
{
"filePath": "/www/apps/resources/references/region/IMessageAggregator/methods/region.IMessageAggregator.clearMessages/page.mdx",
@@ -15408,12 +15504,12 @@ export const filesMap = [
"pathname": "/references/stock_location_next/types/stock_location_next.UpdateStockLocationInput"
},
{
"filePath": "/www/apps/resources/references/stock_location_next_models/classes/stock_location_next_models.StockLocation/page.mdx",
"pathname": "/references/stock_location_next_models/classes/stock_location_next_models.StockLocation"
"filePath": "/www/apps/resources/references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx",
"pathname": "/references/stock_location_next_models/variables/stock_location_next_models.StockLocation"
},
{
"filePath": "/www/apps/resources/references/stock_location_next_models/classes/stock_location_next_models.StockLocationAddress/page.mdx",
"pathname": "/references/stock_location_next_models/classes/stock_location_next_models.StockLocationAddress"
"filePath": "/www/apps/resources/references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx",
"pathname": "/references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress"
},
{
"filePath": "/www/apps/resources/references/store/IMessageAggregator/methods/store.IMessageAggregator.clearMessages/page.mdx",
@@ -15964,20 +16060,20 @@ export const filesMap = [
"pathname": "/references/tax/types/tax.Scalar"
},
{
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxProvider/page.mdx",
"pathname": "/references/tax_models/classes/tax_models.TaxProvider"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxProvider/page.mdx",
"pathname": "/references/tax_models/variables/tax_models.TaxProvider"
},
{
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRate/page.mdx",
"pathname": "/references/tax_models/classes/tax_models.TaxRate"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRate/page.mdx",
"pathname": "/references/tax_models/variables/tax_models.TaxRate"
},
{
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRateRule/page.mdx",
"pathname": "/references/tax_models/classes/tax_models.TaxRateRule"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRateRule/page.mdx",
"pathname": "/references/tax_models/variables/tax_models.TaxRateRule"
},
{
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRegion/page.mdx",
"pathname": "/references/tax_models/classes/tax_models.TaxRegion"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRegion/page.mdx",
"pathname": "/references/tax_models/variables/tax_models.TaxRegion"
},
{
"filePath": "/www/apps/resources/references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx",
@@ -18379,6 +18475,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionListResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionListResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionResponse"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionType/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionType"
@@ -18675,6 +18775,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StepInvokeResult/page.mdx",
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.StepInvokeResult"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StoreCalculateShippingOptionPrice/page.mdx",
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.StoreCalculateShippingOptionPrice"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StoreCollectionListResponse/page.mdx",
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.StoreCollectionListResponse"
@@ -19131,10 +19235,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShipmentWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShipmentWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingProfilesWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingProfilesWorkflowInput"
@@ -19151,14 +19251,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateServiceZonesWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateServiceZonesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingProfilesWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingProfilesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowOutput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowOutput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateFulfillmentAddressWorkflowDTO/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateFulfillmentAddressWorkflowDTO"
@@ -19179,6 +19283,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateFulfillmentWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateFulfillmentWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowOutput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowOutput"
@@ -19187,6 +19295,22 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingProfilesWorkflowOutput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingProfilesWorkflowOutput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowOutput/page.mdx",
"pathname": "/references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowOutput"
@@ -20567,6 +20691,22 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.CleanupObject-1/page.mdx",
"pathname": "/references/types/types/types.CleanupObject-1"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CreateCalculatedShippingOptionInput/page.mdx",
"pathname": "/references/types/types/types.CreateCalculatedShippingOptionInput"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CreateFlatRateShippingOptionInput/page.mdx",
"pathname": "/references/types/types/types.CreateFlatRateShippingOptionInput"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx",
"pathname": "/references/types/types/types.CreateFlatRateShippingOptionPriceRecord"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CreateFlatShippingOptionInputBase/page.mdx",
"pathname": "/references/types/types/types.CreateFlatShippingOptionInputBase"
},
{
"filePath": "/www/apps/resources/references/types/types/types.CreateProductVariantWorkflowInputDTO/page.mdx",
"pathname": "/references/types/types/types.CreateProductVariantWorkflowInputDTO"
@@ -20903,6 +21043,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/types/types.UncountableRules/page.mdx",
"pathname": "/references/types/types/types.UncountableRules"
},
{
"filePath": "/www/apps/resources/references/types/types/types.UpdateFlatShippingOptionInputBase/page.mdx",
"pathname": "/references/types/types/types.UpdateFlatShippingOptionInputBase"
},
{
"filePath": "/www/apps/resources/references/types/types/types.UpdateFulfillmentShippingOptionRulesWorkflowDTO/page.mdx",
"pathname": "/references/types/types/types.UpdateFulfillmentShippingOptionRulesWorkflowDTO"
www/apps/resources/generated/sidebar.mjs
+70 -6
View File
@@ -1653,7 +1653,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "category",
"title": "Data Models",
"autogenerate_path": "/references/customer_models/classes",
"autogenerate_path": "/references/customer_models/variables",
"children": [
{
"loaded": true,
@@ -1804,6 +1804,14 @@ export const generatedSidebar = [
"title": "Methods",
"autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/fulfillment/calculateShippingOptionsPrices",
"title": "calculateShippingOptionsPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -1876,6 +1884,14 @@ export const generatedSidebar = [
"title": "createShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/fulfillment/deleteFulfillment",
"title": "deleteFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -2331,6 +2347,14 @@ export const generatedSidebar = [
"path": "/references/fulfillment/validateShippingOption",
"title": "validateShippingOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/fulfillment/validateShippingOptionsForPriceCalculation",
"title": "validateShippingOptionsForPriceCalculation",
"children": []
}
]
}
@@ -2832,7 +2856,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "category",
"title": "Data Models",
"autogenerate_path": "/references/inventory_next_models/classes",
"autogenerate_path": "/references/inventory_next_models/variables",
"children": [
{
"loaded": true,
@@ -4675,7 +4699,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "category",
"title": "Data Models",
"autogenerate_path": "/references/payment_models/classes",
"autogenerate_path": "/references/payment_models/variables",
"children": [
{
"loaded": true,
@@ -6379,7 +6403,7 @@ export const generatedSidebar = [
"type": "category",
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/promotion_models/classes",
"autogenerate_path": "/references/promotion_models/variables",
"children": [
{
"loaded": true,
@@ -6974,7 +6998,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "category",
"title": "Data Models",
"autogenerate_path": "/references/stock_location_next_models/classes",
"autogenerate_path": "/references/stock_location_next_models/variables",
"children": [
{
"loaded": true,
@@ -7448,7 +7472,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "category",
"title": "Data Models",
"autogenerate_path": "/references/tax_models/classes",
"autogenerate_path": "/references/tax_models/variables",
"children": [
{
"loaded": true,
@@ -9696,6 +9720,14 @@ export const generatedSidebar = [
"title": "enum",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/data-model/property-types/float",
"title": "float",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -9803,6 +9835,14 @@ export const generatedSidebar = [
"title": "Property Configuration Methods",
"autogenerate_path": "/references/dml/Property_Configuration_Methods/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/data-model/property-configuration/computed",
"title": "computed",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -10237,6 +10277,14 @@ export const generatedSidebar = [
"title": "createPaymentCollectionForCartWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow",
"title": "listShippingOptionsForCartWithPricingWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -11017,6 +11065,14 @@ export const generatedSidebar = [
"title": "batchShippingOptionRulesWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow",
"title": "calculateShippingOptionsPricesWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -11152,6 +11208,14 @@ export const generatedSidebar = [
"title": "buildPriceSet",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep",
"title": "calculateShippingOptionsPricesStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
www/apps/resources/generated/slug-changes.mjs
+94 -54
View File
@@ -684,6 +684,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx"
},
{
"origSlug": "/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow",
"newSlug": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx"
},
{
"origSlug": "/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow",
"newSlug": "/references/medusa-workflows/listShippingOptionsForCartWorkflow",
@@ -949,6 +954,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/steps/buildPriceSet",
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.buildPriceSet/page.mdx"
},
{
"origSlug": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep",
"newSlug": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep",
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx"
},
{
"origSlug": "/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep",
"newSlug": "/references/medusa-workflows/steps/cancelFulfillmentStep",
@@ -1039,6 +1049,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/batchShippingOptionRulesWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx"
},
{
"origSlug": "/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow",
"newSlug": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow",
"filePath": "/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx"
},
{
"origSlug": "/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow",
"newSlug": "/references/medusa-workflows/cancelFulfillmentWorkflow",
@@ -3390,24 +3405,24 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/customer/interfaces/customer.ICustomerModuleService/page.mdx"
},
{
"origSlug": "/references/customer_models/classes/customer_models.Customer",
"origSlug": "/references/customer_models/variables/customer_models.Customer",
"newSlug": "/references/customer/models/Customer",
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.Customer/page.mdx"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.Customer/page.mdx"
},
{
"origSlug": "/references/customer_models/classes/customer_models.CustomerAddress",
"origSlug": "/references/customer_models/variables/customer_models.CustomerAddress",
"newSlug": "/references/customer/models/CustomerAddress",
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerAddress/page.mdx"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerAddress/page.mdx"
},
{
"origSlug": "/references/customer_models/classes/customer_models.CustomerGroup",
"origSlug": "/references/customer_models/variables/customer_models.CustomerGroup",
"newSlug": "/references/customer/models/CustomerGroup",
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerGroup/page.mdx"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerGroup/page.mdx"
},
{
"origSlug": "/references/customer_models/classes/customer_models.CustomerGroupCustomer",
"origSlug": "/references/customer_models/variables/customer_models.CustomerGroupCustomer",
"newSlug": "/references/customer/models/CustomerGroupCustomer",
"filePath": "/www/apps/resources/references/customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx"
"filePath": "/www/apps/resources/references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx"
},
{
"origSlug": "/references/dml/Model_Methods/methods/dml.Model_Methods.cascades",
@@ -3419,6 +3434,11 @@ export const slugChanges = [
"newSlug": "/references/data-model/model-methods/indexes",
"filePath": "/www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx"
},
{
"origSlug": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed",
"newSlug": "/references/data-model/property-configuration/computed",
"filePath": "/www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx"
},
{
"origSlug": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default",
"newSlug": "/references/data-model/property-configuration/default",
@@ -3464,6 +3484,11 @@ export const slugChanges = [
"newSlug": "/references/data-model/property-types/enum",
"filePath": "/www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.enum/page.mdx"
},
{
"origSlug": "/references/dml/Property_Types/methods/dml.Property_Types.float",
"newSlug": "/references/data-model/property-types/float",
"filePath": "/www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx"
},
{
"origSlug": "/references/dml/Property_Types/methods/dml.Property_Types.id",
"newSlug": "/references/data-model/property-types/id",
@@ -3534,6 +3559,11 @@ export const slugChanges = [
"newSlug": "/references/file-provider-module",
"filePath": "/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices",
"newSlug": "/references/fulfillment/calculateShippingOptionsPrices",
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment",
"newSlug": "/references/fulfillment/cancelFulfillment",
@@ -3579,6 +3609,11 @@ export const slugChanges = [
"newSlug": "/references/fulfillment/createShippingProfiles",
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment",
"newSlug": "/references/fulfillment/deleteFulfillment",
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets",
"newSlug": "/references/fulfillment/deleteFulfillmentSets",
@@ -3864,6 +3899,11 @@ export const slugChanges = [
"newSlug": "/references/fulfillment/validateShippingOption",
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation",
"newSlug": "/references/fulfillment/validateShippingOptionsForPriceCalculation",
"filePath": "/www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx"
},
{
"origSlug": "/references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService",
"newSlug": "/references/fulfillment",
@@ -4155,19 +4195,19 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/inventory_next/interfaces/inventory_next.IInventoryService/page.mdx"
},
{
"origSlug": "/references/inventory_next_models/classes/inventory_next_models.InventoryItem",
"origSlug": "/references/inventory_next_models/variables/inventory_next_models.InventoryItem",
"newSlug": "/references/inventory-next/models/InventoryItem",
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx"
},
{
"origSlug": "/references/inventory_next_models/classes/inventory_next_models.InventoryLevel",
"origSlug": "/references/inventory_next_models/variables/inventory_next_models.InventoryLevel",
"newSlug": "/references/inventory-next/models/InventoryLevel",
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx"
},
{
"origSlug": "/references/inventory_next_models/classes/inventory_next_models.ReservationItem",
"origSlug": "/references/inventory_next_models/variables/inventory_next_models.ReservationItem",
"newSlug": "/references/inventory-next/models/ReservationItem",
"filePath": "/www/apps/resources/references/inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx"
"filePath": "/www/apps/resources/references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx"
},
{
"origSlug": "/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey",
@@ -5520,44 +5560,44 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/payment/interfaces/payment.IPaymentModuleService/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.Capture",
"origSlug": "/references/payment_models/variables/payment_models.Capture",
"newSlug": "/references/payment/models/Capture",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Capture/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Capture/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.Payment",
"origSlug": "/references/payment_models/variables/payment_models.Payment",
"newSlug": "/references/payment/models/Payment",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Payment/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Payment/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.PaymentCollection",
"origSlug": "/references/payment_models/variables/payment_models.PaymentCollection",
"newSlug": "/references/payment/models/PaymentCollection",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentCollection/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentCollection/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.PaymentMethodToken",
"origSlug": "/references/payment_models/variables/payment_models.PaymentMethodToken",
"newSlug": "/references/payment/models/PaymentMethodToken",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentMethodToken/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentMethodToken/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.PaymentProvider",
"origSlug": "/references/payment_models/variables/payment_models.PaymentProvider",
"newSlug": "/references/payment/models/PaymentProvider",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentProvider/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentProvider/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.PaymentSession",
"origSlug": "/references/payment_models/variables/payment_models.PaymentSession",
"newSlug": "/references/payment/models/PaymentSession",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.PaymentSession/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.PaymentSession/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.Refund",
"origSlug": "/references/payment_models/variables/payment_models.Refund",
"newSlug": "/references/payment/models/Refund",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.Refund/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.Refund/page.mdx"
},
{
"origSlug": "/references/payment_models/classes/payment_models.RefundReason",
"origSlug": "/references/payment_models/variables/payment_models.RefundReason",
"newSlug": "/references/payment/models/RefundReason",
"filePath": "/www/apps/resources/references/payment_models/classes/payment_models.RefundReason/page.mdx"
"filePath": "/www/apps/resources/references/payment_models/variables/payment_models.RefundReason/page.mdx"
},
{
"origSlug": "/references/payment_provider/classes/payment_provider.AbstractPaymentProvider",
@@ -6370,34 +6410,34 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/promotion/interfaces/promotion.IPromotionModuleService/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.ApplicationMethod",
"origSlug": "/references/promotion_models/variables/promotion_models.ApplicationMethod",
"newSlug": "/references/promotion/models/ApplicationMethod",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.ApplicationMethod/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.Campaign",
"origSlug": "/references/promotion_models/variables/promotion_models.Campaign",
"newSlug": "/references/promotion/models/Campaign",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.Campaign/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.Campaign/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.CampaignBudget",
"origSlug": "/references/promotion_models/variables/promotion_models.CampaignBudget",
"newSlug": "/references/promotion/models/CampaignBudget",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.CampaignBudget/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.Promotion",
"origSlug": "/references/promotion_models/variables/promotion_models.Promotion",
"newSlug": "/references/promotion/models/Promotion",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.Promotion/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.Promotion/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.PromotionRule",
"origSlug": "/references/promotion_models/variables/promotion_models.PromotionRule",
"newSlug": "/references/promotion/models/PromotionRule",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRule/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.PromotionRule/page.mdx"
},
{
"origSlug": "/references/promotion_models/classes/promotion_models.PromotionRuleValue",
"origSlug": "/references/promotion_models/variables/promotion_models.PromotionRuleValue",
"newSlug": "/references/promotion/models/PromotionRuleValue",
"filePath": "/www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx"
"filePath": "/www/apps/resources/references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx"
},
{
"origSlug": "/references/region/IRegionModuleService/methods/region.IRegionModuleService.createRegions",
@@ -6585,14 +6625,14 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/stock_location_next/interfaces/stock_location_next.IStockLocationService/page.mdx"
},
{
"origSlug": "/references/stock_location_next_models/classes/stock_location_next_models.StockLocation",
"origSlug": "/references/stock_location_next_models/variables/stock_location_next_models.StockLocation",
"newSlug": "/references/stock-location-next/models/StockLocation",
"filePath": "/www/apps/resources/references/stock_location_next_models/classes/stock_location_next_models.StockLocation/page.mdx"
"filePath": "/www/apps/resources/references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx"
},
{
"origSlug": "/references/stock_location_next_models/classes/stock_location_next_models.StockLocationAddress",
"origSlug": "/references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress",
"newSlug": "/references/stock-location-next/models/StockLocationAddress",
"filePath": "/www/apps/resources/references/stock_location_next_models/classes/stock_location_next_models.StockLocationAddress/page.mdx"
"filePath": "/www/apps/resources/references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx"
},
{
"origSlug": "/references/store/IStoreModuleService/methods/store.IStoreModuleService.createStores",
@@ -6765,24 +6805,24 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/tax/interfaces/tax.ITaxModuleService/page.mdx"
},
{
"origSlug": "/references/tax_models/classes/tax_models.TaxProvider",
"origSlug": "/references/tax_models/variables/tax_models.TaxProvider",
"newSlug": "/references/tax/models/TaxProvider",
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxProvider/page.mdx"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxProvider/page.mdx"
},
{
"origSlug": "/references/tax_models/classes/tax_models.TaxRate",
"origSlug": "/references/tax_models/variables/tax_models.TaxRate",
"newSlug": "/references/tax/models/TaxRate",
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRate/page.mdx"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRate/page.mdx"
},
{
"origSlug": "/references/tax_models/classes/tax_models.TaxRateRule",
"origSlug": "/references/tax_models/variables/tax_models.TaxRateRule",
"newSlug": "/references/tax/models/TaxRateRule",
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRateRule/page.mdx"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRateRule/page.mdx"
},
{
"origSlug": "/references/tax_models/classes/tax_models.TaxRegion",
"origSlug": "/references/tax_models/variables/tax_models.TaxRegion",
"newSlug": "/references/tax/models/TaxRegion",
"filePath": "/www/apps/resources/references/tax_models/classes/tax_models.TaxRegion/page.mdx"
"filePath": "/www/apps/resources/references/tax_models/variables/tax_models.TaxRegion/page.mdx"
},
{
"origSlug": "/references/tax_provider/interfaces/tax_provider.ITaxProvider",
www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"Line truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"nLine truncated
www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TeLine truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TeLine truncated
www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"BelongsLine truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"BelongsTLine truncated
www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`"Line truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","Line truncated
www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProperty`","description":"The ID of the type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`TextProperty`","description":"The collection of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"Line truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProperty`","description":"The ID of the type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`TextProperty`","description":"The collection of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"Line truncated
www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The shipping method adjustment's amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[ShippingMethodTaxLine](../cart_models.ShippingMethodTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax lines.","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The shipping method adjustment's amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[ShippingMethodTaxLine](../cart_models.ShippingMethodTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax lines.","optional":true,"defaultValue":"","expandable":false,"childrenLine truncated
www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx
+1 -1
View File
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[ShippingMethodTaxLine](page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of Line truncated
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;[Address](../cart_models.Address/page.mdx)&#62;","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[ShippingMethodTaxLine](page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of thLine truncated
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ This workflow adds shipping methods to a cart.
## Steps
<WorkflowDiagram workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx","depth":2},{"type":"workflow","name":"listShippingOptionsForCartWorkflow","description":"This workflow lists the shipping options of a cart.","link":"../core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.addShippingMethodToCartStep/page.mdx","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":6}]}} />
<WorkflowDiagram workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx","depth":2},{"type":"workflow","name":"listShippingOptionsForCartWithPricingWorkflow","description":"This workflow lists the shipping options of a cart.","link":"../core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.addShippingMethodToCartStep/page.mdx","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":6}]}} />
## Input
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx
+2 -2
View File
@@ -13,8 +13,8 @@ This workflow adds items to a cart.
## Steps
<WorkflowDiagram workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":6}]}} />
<WorkflowDiagram workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx","depth":4},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":5},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx","depth":6},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":7}]}} />
## Input
<TypeList types={[{"name":"AddToCartWorkflowInputDTO","type":"[AddToCartWorkflowInputDTO](../../../../../types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"[CreateCartCreateLineItemDTO](../../../../../types/interfaces/types.CreateCartCreateLineItemDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","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](../../../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","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":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","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":"","opLine truncated
<TypeList types={[{"name":"AddToCartWorkflowInputDTO","type":"[AddToCartWorkflowInputDTO](../../../../../types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CreateCartCreateLineItemDTO](../../../../../types/interfaces/types.CreateCartCreateLineItemDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","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](../../../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","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":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","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":[]},{"Line truncated
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx
+24
View File
@@ -0,0 +1,24 @@
---
slug: /references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow
sidebar_label: listShippingOptionsForCartWithPricingWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# listShippingOptionsForCartWithPricingWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `listShippingOptionsForCartWithPricingWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow lists the shipping options of a cart.
## Steps
<WorkflowDiagram workflow={{"name":"listShippingOptionsForCartWithPricingWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"validatePresenceOfStep","description":"This step validates the presence of attributes on an object","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.validatePresenceOfStep/page.mdx","depth":2},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"calculateShippingOptionsPricesStep","description":"This step calculates the prices for one or more shipping options.","link":"../../../../Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx","depth":6}]}} />
## Input
<TypeList types={[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`[]","description":"","optional":true,"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":[]}]},{"name":"is_return","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enabled_in_store","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForCartWithPricingWorkflow"/>
## Output
<TypeList types={[{"name":"any[]","type":"`any`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForCartWithPricingWorkflow"/>
www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx
+2 -2
View File
@@ -13,8 +13,8 @@ This workflow updates a cart's line item.
## Steps
<WorkflowDiagram workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":4}]}} />
<WorkflowDiagram workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":5}]}} />
## Input
<TypeList types={[{"name":"UpdateLineItemInCartWorkflowInputDTO","type":"[UpdateLineItemInCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart","type":"[CartDTO](../../../../../cart/interfaces/cart.CartDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item total of the cart.","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":"original_item_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","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":"original_item_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","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_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item total of the cart.","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_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","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_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","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":"original_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","opLine truncated
<TypeList types={[{"name":"UpdateLineItemInCartWorkflowInputDTO","type":"[UpdateLineItemInCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"Partial&#60;[UpdateLineItemDTO](../../../../../cart/interfaces/cart.UpdateLineItemDTO/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The associated cart's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`string`","description":"The title of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`string`","description":"The description of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`string`","description":"The subtitle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`string`","description":"The type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`string`","description":"The collection of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`string`","description":"The handle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`string`","description":"The SKU of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`string`","description":"The barcode of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`string`","description":"The title of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`Record<string, unknown>`","description":"The option values of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the line item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Whether the line item is discountable.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the line item's amount is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberInput](../../../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The calculated price of the line item after applying promotions.","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](../../../../../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":"title","type":"`string`","description":"The title of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quLine truncated
www/apps/resources/references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId/page.mdx
+5
View File
@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# listShippingOptionsForCartWithPricingWorkflowId
`Const` **listShippingOptionsForCartWithPricingWorkflowId**: `"list-shipping-options-for-cart-with-pricing"`
www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ This workflow creates an authentication account for a customer.
## Steps
<WorkflowDiagram workflow={{"name":"createCustomerAccountWorkflow","steps":[{"type":"step","name":"createCustomersStep","description":"This step creates one or more customers.","link":"../../../Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx","depth":1},{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../../../Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx","depth":2}]}} />
<WorkflowDiagram workflow={{"name":"createCustomerAccountWorkflow","steps":[{"type":"workflow","name":"createCustomersWorkflow","description":"This workflow creates one or more customers.","link":"../core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx","depth":1},{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../../../Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx","depth":2}]}} />
## Input
www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx
+20
View File
@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/steps/calculateShippingOptionsPricesStep
sidebar_label: calculateShippingOptionsPricesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# calculateShippingOptionsPricesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `calculateShippingOptionsPricesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step calculates the prices for one or more shipping options.
## Input
<TypeList types={[{"name":"CalculateShippingOptionPriceDTO[]","type":"[CalculateShippingOptionPriceDTO](../../../../../fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CalculateShippingOptionPriceDTO","type":"[CalculateShippingOptionPriceDTO](../../../../../fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data needed for the associated fulfillment provider to calculate the price of a shipping option.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionData","type":"`Record<string, unknown>`","description":"The option data from the provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data passed when the price is calculated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx) & `object` & `Record<string, unknown>`","description":"The calculation context needed for the associated fulfillment provider to calculate the price of a shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the cart. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the cart.","optLine truncated
## Output
<TypeList types={[{"name":"CalculatedShippingOptionPrice[]","type":"[CalculatedShippingOptionPrice](../../../../../fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice","type":"[CalculatedShippingOptionPrice](../../../../../fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"calculated_amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculateShippingOptionsPricesStep"/>
www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.setShippingOptionsPricesStep/page.mdx
+1 -1
View File
@@ -13,4 +13,4 @@ This step sets the prices of one or more shipping options.
## Input
<TypeList types={[{"name":"SetShippingOptionsPricesStepInput","type":"[SetShippingOptionsPricesStepInput](../../../../types/core_flows.SetShippingOptionsPricesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[`\"prices\"`]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setShippingOptionsPricesStep"/>
<TypeList types={[{"name":"SetShippingOptionsPricesStepInput","type":"[SetShippingOptionsPricesStepInput](../../../../types/core_flows.SetShippingOptionsPricesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../../types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;TConfig&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../../types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;TConfig&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setShippingOptionsPricesStep"/>
www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.upsertShippingOptionsStep/page.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ This step creates or updates shipping options.
## Input
<TypeList types={[{"name":"UpsertShippingOptionsStepInput","type":"[UpsertShippingOptionsStepInput](../../../../types/core_flows.UpsertShippingOptionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpsertShippingOptionsStepInput","type":"Omit&#60;[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx) \\| [UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx), \"prices\"&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertShippingOptionsStep"/>
<TypeList types={[{"name":"UpsertShippingOptionsStepInput","type":"[UpsertShippingOptionsStepInput](../../../../types/core_flows.UpsertShippingOptionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpsertShippingOptionsStepInput","type":"Omit&#60;[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx) \\| [UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx), \"prices\"&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertShippingOptionsStep"/>
## Output
www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId/page.mdx
+5
View File
@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# calculateShippingOptionsPricesStepId
`Const` **calculateShippingOptionsPricesStepId**: `"calculate-shipping-options-prices"`
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx
+24
View File
@@ -0,0 +1,24 @@
---
slug: /references/medusa-workflows/calculateShippingOptionsPricesWorkflow
sidebar_label: calculateShippingOptionsPricesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# calculateShippingOptionsPricesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `calculateShippingOptionsPricesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow calculates the prices for one or more shipping options.
## Steps
<WorkflowDiagram workflow={{"name":"calculateShippingOptionsPricesWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":2},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":4},{"type":"step","name":"calculateShippingOptionsPricesStep","description":"This step calculates the prices for one or more shipping options.","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStep/page.mdx","depth":5}]}} />
## Input
<TypeList types={[{"name":"CalculateShippingOptionsPricesWorkflowInput","type":"[CalculateShippingOptionsPricesWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculateShippingOptionsPricesWorkflow"/>
## Output
<TypeList types={[{"name":"CalculateShippingOptionsPricesWorkflowOutput","type":"[CalculateShippingOptionsPricesWorkflowOutput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"calculated_amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculateShippingOptionsPricesWorkflow"/>
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ This workflow creates one or more shipping options.
## Input
<TypeList types={[{"name":"CreateShippingOptionsWorkflowInput[]","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createShippingOptionsWorkflow"/>
<TypeList types={[{"name":"CreateShippingOptionsWorkflowInput[]","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateFlatRateShippingOptionInput](../../../../../types/types/types.CreateFlatRateShippingOptionInput/page.mdx) \\| [CreateCalculatedShippingOptionInput](../../../../../types/types/types.CreateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateFlatRateShippingOptionPriceRecord](../../../../../types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"calculated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createShippingOptionsWorkflow"/>
## Output
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ This workflow updates one or more shipping options.
## Input
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateFlatRateShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput/page.mdx) \\| [UpdateCalculatedShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
## Output
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId/page.mdx
+5
View File
@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# calculateShippingOptionsPricesWorkflowId
`Const` **calculateShippingOptionsPricesWorkflowId**: `"calculate-shipping-options-prices-workflow"`
www/apps/resources/references/core_flows/types/core_flows.UpsertShippingOptionsStepInput/page.mdx
+1 -1
View File
@@ -2,4 +2,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# UpsertShippingOptionsStepInput
**UpsertShippingOptionsStepInput**: Omit&#60;[CreateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx) \| [UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx), "prices"&#62;[]
**UpsertShippingOptionsStepInput**: Omit&#60;[CreateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx) \| [UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx), "prices"&#62;[]
www/apps/resources/references/customer_models/classes/customer_models.Customer/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/Customer
sidebar_label: Customer
---
import { TypeList } from "docs-ui"
# Customer - Customer Module Data Models Reference
This documentation provides a reference to the Customer . This belongs to the Customer Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"groups","type":"Collection&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"Collection&#60;[Customer](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"groups","type":"Collection&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"Collection&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalCustomerProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"addresses","type":"Collection&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OLine truncated
www/apps/resources/references/customer_models/classes/customer_models.CustomerAddress/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerAddress
sidebar_label: CustomerAddress
---
import { TypeList } from "docs-ui"
# CustomerAddress - Customer Module Data Models Reference
This documentation provides a reference to the CustomerAddress . This belongs to the Customer Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../customer_models.Customer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"groups","type":"Collection&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"Collection&#60;[Customer](../customer_models.Customer/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"addresses","type":"Collection&#60;[CustomerAddress](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../customer_models.Customer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"childreLine truncated
www/apps/resources/references/customer_models/classes/customer_models.CustomerGroup/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerGroup
sidebar_label: CustomerGroup
---
import { TypeList } from "docs-ui"
# CustomerGroup - Customer Module Data Models Reference
This documentation provides a reference to the CustomerGroup . This belongs to the Customer Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"Collection&#60;[Customer](../customer_models.Customer/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"groups","type":"Collection&#60;[CustomerGroup](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"Collection&#60;[Customer](../customer_models.Customer/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"addresses","type":"Collection&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../customer_models.Customer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"dLine truncated
www/apps/resources/references/customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerGroupCustomer
sidebar_label: CustomerGroupCustomer
---
import { TypeList } from "docs-ui"
# CustomerGroupCustomer - Customer Module Data Models Reference
This documentation provides a reference to the CustomerGroupCustomer . This belongs to the Customer Module.
<TypeList types={[{"name":"[OptionalProps]","type":"`OptionalGroupProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../customer_models.Customer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"groups","type":"Collection&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"Collection&#60;[Customer](../customer_models.Customer/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"addresses","type":"Collection&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../customer_models.Customer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"Line truncated
www/apps/resources/references/customer_models/variables/customer_models.Customer/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/Customer
sidebar_label: Customer
---
import { TypeList } from "docs-ui"
# Customer - Customer Module Data Models Reference
This documentation provides a reference to the Customer data model. It belongs to the Customer Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany&#60;[Customer](page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"company_name","type":"`TextProperty`","description":"The company name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"Line truncated
www/apps/resources/references/customer_models/variables/customer_models.CustomerAddress/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerAddress
sidebar_label: CustomerAddress
---
import { TypeList } from "docs-ui"
# CustomerAddress - Customer Module Data Models Reference
This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"Line truncated
www/apps/resources/references/customer_models/variables/customer_models.CustomerGroup/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerGroup
sidebar_label: CustomerGroup
---
import { TypeList } from "docs-ui"
# CustomerGroup - Customer Module Data Models Reference
This documentation provides a reference to the CustomerGroup data model. It belongs to the Customer Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany&#60;[CustomerGroup](page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value paiLine truncated
www/apps/resources/references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerModelReference
slug: /references/customer/models/CustomerGroupCustomer
sidebar_label: CustomerGroupCustomer
---
import { TypeList } from "docs-ui"
# CustomerGroupCustomer - Customer Module Data Models Reference
This documentation provides a reference to the CustomerGroupCustomer data model. It belongs to the Customer Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the group-customer pairing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany&#60;[CustomerGroup](../customer_models.CustomerGroup/page.mdx)&#62;","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany&#60;[CustomerAddress](../customer_models.CustomerAddress/page.mdx)&#62;","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo&#60;[Customer](../customer_models.Customer/page.mdx)&#62;","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"company_name","type":"`TextProperLine truncated
www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.cascades/page.mdx
+1 -1
View File
@@ -28,4 +28,4 @@ const Store = model.define("store", {
## Parameters
<TypeList types={[{"name":"options","type":"[EntityCascades](../../../../types/DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx)&#60;[ExtractEntityRelations](../../../../types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations/page.mdx)&#60;Schema, \"hasOne\" \\| \"hasOneWithFK\" \\| \"hasMany\"&#62;&#62;","description":"The cascades configurations. They object's keys are the names of\nthe actions, such as `deleted`, and the value is an array of relations that the\naction should be cascaded to.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"delete","type":"Relationships","description":"The related models to delete when a record of this data model\nis deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cascades"/>
<TypeList types={[{"name":"options","type":"[EntityCascades](../../../../types/DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx)&#60;[ExtractEntityRelations](../../../../types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations/page.mdx)&#60;Schema, \"hasOne\" \\| \"hasOneWithFK\" \\| \"hasMany\"&#62;, [ExtractEntityRelations](../../../../types/DmlTypes/types/types.DmlTypes.ExtractEntityRelations/page.mdx)&#60;Schema, \"manyToMany\"&#62;&#62;","description":"The cascades configurations. They object's keys are the names of\nthe actions, such as `deleted`, and the value is an array of relations that the\naction should be cascaded to.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"delete","type":"DeletableRelationships","description":"The related models to delete when a record of this data model\nis deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"detach","type":"DetachableRelationships","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cascades"/>
www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx
+25
View File
@@ -0,0 +1,25 @@
---
slug: /references/data-model/property-configuration/computed
sidebar_label: computed
---
import { TypeList } from "docs-ui"
# computed Method - DML Reference
This method indicated that the property is a computed property.
Computed properties are not stored in the database but are
computed on the fly.
## Example
```ts
import { model } from "@medusajs/framework/utils"
const MyCustom = model.define("my_custom", {
calculated_price: model.bigNumber().computed(),
// ...
})
export default MyCustom
```
www/apps/resources/references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx
+30
View File
@@ -0,0 +1,30 @@
---
slug: /references/data-model/property-types/float
sidebar_label: float
---
import { TypeList } from "docs-ui"
# float Property Method - DML Reference
This method defines a float property that allows for
values with decimal places
:::note
This is only available after Medusa `v2.1.2`.
:::
## Example
```ts
import { model } from "@medusajs/framework/utils"
const MyCustom = model.define("tax", {
tax_rate: model.float(),
// ...
})
export default MyCustom
```
www/apps/resources/references/dml/dml.Property_Configuration_Methods/page.mdx
+1
View File
@@ -10,6 +10,7 @@ The following methods are used on a property to configure it.
## Methods
- [computed](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx)
- [default](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx)
- [index](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [nullable](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
www/apps/resources/references/dml/dml.Property_Types/page.mdx
+1
View File
@@ -15,6 +15,7 @@ The following methods are used to define the type of a property in a data model.
- [boolean](../Property_Types/methods/dml.Property_Types.boolean/page.mdx)
- [dateTime](../Property_Types/methods/dml.Property_Types.dateTime/page.mdx)
- [enum](../Property_Types/methods/dml.Property_Types.enum/page.mdx)
- [float](../Property_Types/methods/dml.Property_Types.float/page.mdx)
- [id](../Property_Types/methods/dml.Property_Types.id/page.mdx)
- [json](../Property_Types/methods/dml.Property_Types.json/page.mdx)
- [number](../Property_Types/methods/dml.Property_Types.number/page.mdx)
www/apps/resources/references/dml/entity_builder/classes/dml.entity_builder.EntityBuilder/page.mdx
+1
View File
@@ -19,6 +19,7 @@ schema using the shorthand methods.
- [dateTime](../../../Property_Types/methods/dml.Property_Types.dateTime/page.mdx)
- [define](../../EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx)
- [enum](../../../Property_Types/methods/dml.Property_Types.enum/page.mdx)
- [float](../../../Property_Types/methods/dml.Property_Types.float/page.mdx)
- [hasMany](../../../Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx)
- [hasOne](../../../Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx)
- [id](../../../Property_Types/methods/dml.Property_Types.id/page.mdx)
www/apps/resources/references/dml/properties_base/classes/dml.properties_base.BaseProperty/page.mdx
+1
View File
@@ -15,6 +15,7 @@ property classes
## Methods
- [computed](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx)
- [default](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx)
- [index](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [nullable](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx
+45
View File
@@ -0,0 +1,45 @@
---
displayed_sidebar: fulfillmentReference
slug: /references/fulfillment/calculateShippingOptionsPrices
sidebar_label: calculateShippingOptionsPrices
---
import { TypeList } from "docs-ui"
# calculateShippingOptionsPrices - Fulfillment Module Reference
This documentation provides a reference to the `calculateShippingOptionsPrices` method. This belongs to the Fulfillment Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method calculates the prices for one or more shipping options.
## Example
```ts
const prices =
await fulfillmentModuleService.calculateShippingOptionsPrices(
[
{
provider_id: "webshipper",
data: {
cart: {
id: "cart_123",
},
},
},
]
)
```
## Parameters
<TypeList types={[{"name":"shippingOptionsData","type":"[CalculateShippingOptionPriceDTO](../../../interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx)[]","description":"The shipping options data to calculate the prices for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionData","type":"`Record<string, unknown>`","description":"The option data from the provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data passed when the price is calculated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[CartDTO](../../../interfaces/fulfillment.CartDTO/page.mdx) & `object` & `Record<string, unknown>`","description":"The calculation context needed for the associated fulfillment provider to calculate the price of a shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the cart. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"[BigNumberValue](../../../types/fulfillment.BigNumberValue/page.mdx)","description":"The gift card total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"[BigNumberValue](../../../types/fulfiLine truncated
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[CalculatedShippingOptionPrice](../../../types/fulfillment.CalculatedShippingOptionPrice/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The calculated shipping option prices.","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice[]","type":"[CalculatedShippingOptionPrice](../../../types/fulfillment.CalculatedShippingOptionPrice/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculateShippingOptionsPrices"/>
www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx
+33
View File
@@ -0,0 +1,33 @@
---
displayed_sidebar: fulfillmentReference
slug: /references/fulfillment/deleteFulfillment
sidebar_label: deleteFulfillment
---
import { TypeList } from "docs-ui"
# deleteFulfillment - Fulfillment Module Reference
This documentation provides a reference to the `deleteFulfillment` method. This belongs to the Fulfillment Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method deletes fulfillment by IDs after cancelation.
## Example
```ts
await fulfillmentModuleService.deleteFulfillment("ful_123")
```
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteFulfillment"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Resolves when the fulfillment set is deleted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteFulfillment"/>
www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx
+41
View File
@@ -0,0 +1,41 @@
---
displayed_sidebar: fulfillmentReference
slug: /references/fulfillment/validateShippingOptionsForPriceCalculation
sidebar_label: validateShippingOptionsForPriceCalculation
---
import { TypeList } from "docs-ui"
# validateShippingOptionsForPriceCalculation - Fulfillment Module Reference
This documentation provides a reference to the `validateShippingOptionsForPriceCalculation` method. This belongs to the Fulfillment Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
This method checks whether a shipping option can have calculated price.
## Example
```ts
const isValid =
await fulfillmentModuleService.validateShippingOptionsForPriceCalculation(
[
{
provider_id: "webshipper",
price_type: "calculated",
},
]
)
```
## Parameters
<TypeList types={[{"name":"shippingOptionsData","type":"[CreateShippingOptionDTO](../../../interfaces/fulfillment.CreateShippingOptionDTO/page.mdx)[]","description":"The shipping options data to check.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"Omit&#60;[CreateShippingOptionTypeDTO](../../../interfaces/fulfillment.CreateShippingOptionTypeDTO/page.mdx), \"shipping_option_id\"&#62;","description":"The shipping option type associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"The label of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand its associated fulfillments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit&#60;[CreateShippingOptionRuleDTO](../../../interfaces/fulfillment.CreateShippingOptionRuleDTO/page.mdx), \"shipping_option_id\"&#62;[]","description":"The shipping option rules associated with the shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"The attribute of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../types/fulfillment.RuleOperatorType/page.mdx)","description":"The operator of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The value(s) of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":""Line truncated
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;boolean[]&#62;","optional":false,"defaultValue":"","description":"Whether the shipping options can have calculated price.","expandable":false,"children":[{"name":"boolean[]","type":"`boolean`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateShippingOptionsForPriceCalculation"/>
www/apps/resources/references/fulfillment/interfaces/fulfillment.AdjustmentLineDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# AdjustmentLineDTO
The adjustment line details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_amount","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw 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":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the adjustment line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The ID of the associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdjustmentLineDTO"/>
www/apps/resources/references/fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CalculateShippingOptionPriceDTO
The data needed for the associated fulfillment provider to calculate the price of a shipping option.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionData","type":"`Record<string, unknown>`","description":"The option data from the provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data passed when the price is calculated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[CartDTO](../fulfillment.CartDTO/page.mdx) & `object` & `Record<string, unknown>`","description":"The calculation context needed for the associated fulfillment provider to calculate the price of a shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":tLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.CartAddressDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CartAddressDTO
The cart address details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","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":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartAddressDTO"/>
www/apps/resources/references/fulfillment/interfaces/fulfillment.CartDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CartDTO
The cart details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"nLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.CartLineItemDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CartLineItemDTO
The cart line item details.
<TypeList types={[{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","oLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.CartLineItemTotalsDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CartLineItemTotalsDTO
The cart line item totals details.
<TypeList types={[{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","oLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.CartShippingMethodDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CartShippingMethodDTO
The cart shipping method details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"[BigNumberValue](../../types/fulfillment.Line truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx
+3
View File
@@ -19,6 +19,7 @@ The main service interface for the Fulfillment Module.
## Methods
- [calculateShippingOptionsPrices](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx)
- [cancelFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx)
- [createFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx)
- [createFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx)
@@ -28,6 +29,7 @@ The main service interface for the Fulfillment Module.
- [createShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptionRules/page.mdx)
- [createShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptions/page.mdx)
- [createShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx)
- [deleteFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx)
- [deleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets/page.mdx)
- [deleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteGeoZones/page.mdx)
- [deleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteServiceZones/page.mdx)
@@ -85,3 +87,4 @@ The main service interface for the Fulfillment Module.
- [validateFulfillmentData](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx)
- [validateFulfillmentOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentOption/page.mdx)
- [validateShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption/page.mdx)
- [validateShippingOptionsForPriceCalculation](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx)
www/apps/resources/references/fulfillment/interfaces/fulfillment.LineItemAdjustmentDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# LineItemAdjustmentDTO
The line item adjustment details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_amount","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw 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":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[CartLineItemDTO](../fulfillment.CartLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNuLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.LineItemTaxLineDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# LineItemTaxLineDTO
The line item tax line details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the tax line","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[CartLineItemDTO](../fulfillment.CartLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the cart line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","descriptionLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingMethodAdjustmentDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# ShippingMethodAdjustmentDTO
The shipping method adjustment details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_amount","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw 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":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[CartShippingMethodDTO](../fulfillment.CartShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_taxLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# ShippingMethodTaxLineDTO
The shipping method tax line details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the tax line","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[CartShippingMethodDTO](../fulfillment.CartShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulLine truncated
www/apps/resources/references/fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# TaxLineDTO
The tax line details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the tax line","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","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 ID of the associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TaxLineDTO"/>
www/apps/resources/references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx
+11
View File
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# CalculatedShippingOptionPrice
**CalculatedShippingOptionPrice**: `Object`
<TypeList types={[{"name":"calculated_amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CalculatedShippingOptionPrice"/>
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
+3 -4
View File
@@ -224,11 +224,10 @@ If it returns `true`, Medusa uses this method to retrieve the calculated price.
```ts
class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
// ...
async calculatePrice(optionData: any, data: any, cart: any): Promise<number> {
async calculatePrice(optionData: any, data: any, context: any): Promise<number> {
// assuming the client can calculate the price using
// the third-party service
const price = await this.client.calculate(data)
return price
}
}
@@ -236,11 +235,11 @@ class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
#### Parameters
<TypeList types={[{"name":"optionData","type":"`Record<string, unknown>`","description":"The `data` property of a shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"If the price is calculated for a shipping option, it's the `data` of the shipping option. Otherwise, it's the `data of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculatePrice"/>
<TypeList types={[{"name":"optionData","type":"`Record<string, unknown>`","description":"Shipping option data from the provider, the `data` property of a shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data passed when the price is calculated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[CartDTO](../../../cart/interfaces/cart.CartDTO/page.mdx) & `object` & `Record<string, unknown>`","description":"The context details, such as the cart or customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item total of the cart.","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":"original_item_subtotal","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","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":"original_item_tax_total","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","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_total","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item total of the cart.","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_subtotal","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","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_tax_total","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","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":"original_total","type":"[BigNumberValue](../../../cart/types/cart.BigNumberValue/page.mdx)","description":Line truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;CalculatedShippingOptionPrice&#62;","optional":false,"defaultValue":"","description":"The calculated price","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice","type":"`CalculatedShippingOptionPrice`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculatePrice"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[CalculatedShippingOptionPrice](../../../fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The calculated price","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice","type":"[CalculatedShippingOptionPrice](../../../fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"calculated_amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculatePrice"/>
### createFulfillment
www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/InventoryItem
sidebar_label: InventoryItem
---
import { TypeList } from "docs-ui"
# InventoryItem - Inventory Next Module Data Models Reference
This documentation provides a reference to the InventoryItem . This belongs to the Inventory Next Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"location_levels","type":"Collection&#60;[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","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":[]},{"name":"stocked_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_stocked_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reserved_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_reserved_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"incoming_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_incoming_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`strLine truncated
www/apps/resources/references/inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/InventoryLevel
sidebar_label: InventoryLevel
---
import { TypeList } from "docs-ui"
# InventoryLevel - Inventory Next Module Data Models Reference
This documentation provides a reference to the InventoryLevel . This belongs to the Inventory Next Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","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":[]},{"name":"stocked_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_stocked_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reserved_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_reserved_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"incoming_quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_incoming_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","Line truncated
www/apps/resources/references/inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/ReservationItem
sidebar_label: ReservationItem
---
import { TypeList } from "docs-ui"
# ReservationItem - Inventory Next Module Data Models Reference
This documentation provides a reference to the ReservationItem . This belongs to the Inventory Next Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"location_levels","type":"Collection&#60;[InLine truncated
www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/InventoryItem
sidebar_label: InventoryItem
---
import { TypeList } from "docs-ui"
# InventoryItem - Inventory Next Module Data Models Reference
This documentation provides a reference to the InventoryItem data model. It belongs to the Inventory Next Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany&#60;[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)&#62;","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](page.mdx)&#62;","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany&#60;[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)&#62;","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reservation_items","type":"HasMany&#60;[ReservationItem](../inventory_next_models.ReservationItem/page.mdx)&#62;","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reserved_quantity","type":"ComputedProperty&#60;null \\| number, NumberProperty&#62;","description":"The reserved quantity of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"ComputedProperty&#60;null \\| number, NumberProperty&#62;","description":"The stocked quantity of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`TextProperty`","description":"The origin country of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`TextProperty`","description":"The HS code of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`TextProperty`","description":"The MID code of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`TextProperty`","description":"The material of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`NumberProperty`","description":"The weight of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`NumberProperty`","description":"The length of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`NumberProperty`","description":"The height of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`NumberProperty`","description":"The width of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL ofLine truncated
www/apps/resources/references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/InventoryLevel
sidebar_label: InventoryLevel
---
import { TypeList } from "docs-ui"
# InventoryLevel - Inventory Next Module Data Models Reference
This documentation provides a reference to the InventoryLevel data model. It belongs to the Inventory Next Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany&#60;[InventoryLevel](page.mdx)&#62;","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"available_quantity","type":"ComputedProperty&#60;null \\| number, BigNumberProperty&#62;","description":"The available quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reservation_items","type":"HasMany&#60;[ReservationItem](../inventory_next_models.ReservationItem/page.mdx)&#62;","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventLine truncated
www/apps/resources/references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextModelReference
slug: /references/inventory-next/models/ReservationItem
sidebar_label: ReservationItem
---
import { TypeList } from "docs-ui"
# ReservationItem - Inventory Next Module Data Models Reference
This documentation provides a reference to the ReservationItem data model. It belongs to the Inventory Next Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany&#60;[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)&#62;","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"available_quantity","type":"ComputedProperty&#60;null \\| number, BigNumberProperty&#62;","description":"The available quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reservation_items","type":"HasMany&#60;[ReservationItem](page.mdx)&#62;","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo&#60;[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)&#62;","description":"The associated inventory item.Line truncated
www/apps/resources/references/medusa/interfaces/medusa.MedusaRequest/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & QueryFields","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"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":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","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":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"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":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returneLine truncated
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & QueryFields","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"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":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","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":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"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":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returneLine truncated
www/apps/resources/references/medusa/types/medusa.MedusaPricingContext/page.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
## Properties
<TypeList types={[{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group_id","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaPricingContext"/>
<TypeList types={[{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"groups","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaPricingContext"/>
www/apps/resources/references/modules/customer_models/page.mdx
+6 -8
View File
@@ -13,16 +13,14 @@ This documentation provides a reference to the data models in the Customer Modul
```mermaid
erDiagram
CustomerAddress }|--|{ Customer : customer
Customer }|--|{ CustomerGroup : groups
CustomerGroupCustomer }|--|{ Customer : customer
CustomerGroupCustomer }|--|{ CustomerGroup : customer_group
Customer ||--|| CustomerAddress : addresses
```
## Classes
## Data Models
- [Customer](../../customer_models/classes/customer_models.Customer/page.mdx)
- [CustomerAddress](../../customer_models/classes/customer_models.CustomerAddress/page.mdx)
- [CustomerGroup](../../customer_models/classes/customer_models.CustomerGroup/page.mdx)
- [CustomerGroupCustomer](../../customer_models/classes/customer_models.CustomerGroupCustomer/page.mdx)
- [Customer](../../customer_models/variables/customer_models.Customer/page.mdx)
- [CustomerAddress](../../customer_models/variables/customer_models.CustomerAddress/page.mdx)
- [CustomerGroup](../../customer_models/variables/customer_models.CustomerGroup/page.mdx)
- [CustomerGroupCustomer](../../customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx)
www/apps/resources/references/modules/fulfillment/page.mdx
+13
View File
@@ -4,7 +4,14 @@ import { TypeList } from "docs-ui"
## Interfaces
- [AdjustmentLineDTO](../../fulfillment/interfaces/fulfillment.AdjustmentLineDTO/page.mdx)
- [BaseFilterable](../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)
- [CalculateShippingOptionPriceDTO](../../fulfillment/interfaces/fulfillment.CalculateShippingOptionPriceDTO/page.mdx)
- [CartAddressDTO](../../fulfillment/interfaces/fulfillment.CartAddressDTO/page.mdx)
- [CartDTO](../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)
- [CartLineItemDTO](../../fulfillment/interfaces/fulfillment.CartLineItemDTO/page.mdx)
- [CartLineItemTotalsDTO](../../fulfillment/interfaces/fulfillment.CartLineItemTotalsDTO/page.mdx)
- [CartShippingMethodDTO](../../fulfillment/interfaces/fulfillment.CartShippingMethodDTO/page.mdx)
- [Context](../../fulfillment/interfaces/fulfillment.Context/page.mdx)
- [CreateCityGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateCityGeoZoneDTO/page.mdx)
- [CreateCountryGeoZoneDTO](../../fulfillment/interfaces/fulfillment.CreateCountryGeoZoneDTO/page.mdx)
@@ -45,6 +52,8 @@ import { TypeList } from "docs-ui"
- [IModuleService](../../fulfillment/interfaces/fulfillment.IModuleService/page.mdx)
- [JoinerServiceConfig](../../fulfillment/interfaces/fulfillment.JoinerServiceConfig/page.mdx)
- [JoinerServiceConfigAlias](../../fulfillment/interfaces/fulfillment.JoinerServiceConfigAlias/page.mdx)
- [LineItemAdjustmentDTO](../../fulfillment/interfaces/fulfillment.LineItemAdjustmentDTO/page.mdx)
- [LineItemTaxLineDTO](../../fulfillment/interfaces/fulfillment.LineItemTaxLineDTO/page.mdx)
- [MessageAggregatorFormat](../../fulfillment/interfaces/fulfillment.MessageAggregatorFormat/page.mdx)
- [OrderAddressDTO](../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)
- [OrderAdjustmentLineDTO](../../fulfillment/interfaces/fulfillment.OrderAdjustmentLineDTO/page.mdx)
@@ -68,11 +77,14 @@ import { TypeList } from "docs-ui"
- [RestoreReturn](../../fulfillment/interfaces/fulfillment.RestoreReturn/page.mdx)
- [ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)
- [ServiceZoneDTO](../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)
- [ShippingMethodAdjustmentDTO](../../fulfillment/interfaces/fulfillment.ShippingMethodAdjustmentDTO/page.mdx)
- [ShippingMethodTaxLineDTO](../../fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx)
- [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)
- [ShippingOptionRuleDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)
- [ShippingOptionTypeDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx)
- [ShippingProfileDTO](../../fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx)
- [SoftDeleteReturn](../../fulfillment/interfaces/fulfillment.SoftDeleteReturn/page.mdx)
- [TaxLineDTO](../../fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx)
- [UpdateCityGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateCityGeoZoneDTO/page.mdx)
- [UpdateCountryGeoZoneDTO](../../fulfillment/interfaces/fulfillment.UpdateCountryGeoZoneDTO/page.mdx)
- [UpdateFulfillmentDTO](../../fulfillment/interfaces/fulfillment.UpdateFulfillmentDTO/page.mdx)
@@ -92,6 +104,7 @@ import { TypeList } from "docs-ui"
- [BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)
- [CalculatedShippingOptionPrice](../../fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx)
- [ChangeActionType](../../fulfillment/types/fulfillment.ChangeActionType/page.mdx)
- [Constructor](../../fulfillment/types/fulfillment.Constructor/page.mdx)
- [CreateGeoZoneDTO](../../fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx)
www/apps/resources/references/modules/inventory_next_models/page.mdx
+4 -4
View File
@@ -9,8 +9,8 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the data models in the Inventory Next Module
## Classes
## Data Models
- [InventoryItem](../../inventory_next_models/classes/inventory_next_models.InventoryItem/page.mdx)
- [InventoryLevel](../../inventory_next_models/classes/inventory_next_models.InventoryLevel/page.mdx)
- [ReservationItem](../../inventory_next_models/classes/inventory_next_models.ReservationItem/page.mdx)
- [InventoryItem](../../inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx)
- [InventoryLevel](../../inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx)
- [ReservationItem](../../inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx)
www/apps/resources/references/modules/payment_models/page.mdx
+13 -13
View File
@@ -13,23 +13,23 @@ This documentation provides a reference to the data models in the Payment Module
```mermaid
erDiagram
Capture }|--|{ Payment : payment
Payment ||--|| Refund : refunds
Payment }|--|{ PaymentCollection : payment_collection
Payment ||--|| PaymentSession : payment_session
Payment ||--|| Capture : captures
PaymentCollection }|--|{ PaymentProvider : payment_providers
PaymentCollection ||--|| PaymentSession : payment_sessions
Refund }|--|{ RefundReason : refund_reason
PaymentCollection ||--|| Payment : payments
PaymentSession ||--|| Payment : payment
RefundReason ||--|| Refund : refunds
```
## Classes
## Data Models
- [Capture](../../payment_models/classes/payment_models.Capture/page.mdx)
- [Payment](../../payment_models/classes/payment_models.Payment/page.mdx)
- [PaymentCollection](../../payment_models/classes/payment_models.PaymentCollection/page.mdx)
- [PaymentMethodToken](../../payment_models/classes/payment_models.PaymentMethodToken/page.mdx)
- [PaymentProvider](../../payment_models/classes/payment_models.PaymentProvider/page.mdx)
- [PaymentSession](../../payment_models/classes/payment_models.PaymentSession/page.mdx)
- [Refund](../../payment_models/classes/payment_models.Refund/page.mdx)
- [RefundReason](../../payment_models/classes/payment_models.RefundReason/page.mdx)
- [Capture](../../payment_models/variables/payment_models.Capture/page.mdx)
- [Payment](../../payment_models/variables/payment_models.Payment/page.mdx)
- [PaymentCollection](../../payment_models/variables/payment_models.PaymentCollection/page.mdx)
- [PaymentMethodToken](../../payment_models/variables/payment_models.PaymentMethodToken/page.mdx)
- [PaymentProvider](../../payment_models/variables/payment_models.PaymentProvider/page.mdx)
- [PaymentSession](../../payment_models/variables/payment_models.PaymentSession/page.mdx)
- [Refund](../../payment_models/variables/payment_models.Refund/page.mdx)
- [RefundReason](../../payment_models/variables/payment_models.RefundReason/page.mdx)
www/apps/resources/references/modules/promotion_models/page.mdx
+8 -8
View File
@@ -13,20 +13,20 @@ This documentation provides a reference to the data models in the Promotion Modu
```mermaid
erDiagram
ApplicationMethod ||--|| Promotion : promotion
ApplicationMethod }|--|{ PromotionRule : target_rules
Campaign ||--|| CampaignBudget : budget
Campaign ||--|| Promotion : promotions
Promotion ||--|| ApplicationMethod : application_method
Promotion }|--|{ PromotionRule : rules
PromotionRule ||--|| PromotionRuleValue : values
```
## Classes
## Data Models
- [ApplicationMethod](../../promotion_models/classes/promotion_models.ApplicationMethod/page.mdx)
- [Campaign](../../promotion_models/classes/promotion_models.Campaign/page.mdx)
- [CampaignBudget](../../promotion_models/classes/promotion_models.CampaignBudget/page.mdx)
- [Promotion](../../promotion_models/classes/promotion_models.Promotion/page.mdx)
- [PromotionRule](../../promotion_models/classes/promotion_models.PromotionRule/page.mdx)
- [PromotionRuleValue](../../promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx)
- [ApplicationMethod](../../promotion_models/variables/promotion_models.ApplicationMethod/page.mdx)
- [Campaign](../../promotion_models/variables/promotion_models.Campaign/page.mdx)
- [CampaignBudget](../../promotion_models/variables/promotion_models.CampaignBudget/page.mdx)
- [Promotion](../../promotion_models/variables/promotion_models.Promotion/page.mdx)
- [PromotionRule](../../promotion_models/variables/promotion_models.PromotionRule/page.mdx)
- [PromotionRuleValue](../../promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx)
www/apps/resources/references/modules/stock_location_next_models/page.mdx
+3 -3
View File
@@ -9,7 +9,7 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the data models in the Stock Location Next Module
## Classes
## Data Models
- [StockLocation](../../stock_location_next_models/classes/stock_location_next_models.StockLocation/page.mdx)
- [StockLocationAddress](../../stock_location_next_models/classes/stock_location_next_models.StockLocationAddress/page.mdx)
- [StockLocation](../../stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx)
- [StockLocationAddress](../../stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx)
www/apps/resources/references/modules/tax_models/page.mdx
+7 -8
View File
@@ -13,16 +13,15 @@ This documentation provides a reference to the data models in the Tax Module
```mermaid
erDiagram
TaxRate }|--|{ TaxRegion : tax_region
TaxRate ||--|| TaxRateRule : rules
TaxRegion }|--|{ TaxProvider : provider
TaxRegion }|--|{ TaxRegion : parent
TaxRegion ||--|| TaxRate : tax_rates
TaxProvider ||--|| TaxRegion : regions
```
## Classes
## Data Models
- [TaxProvider](../../tax_models/classes/tax_models.TaxProvider/page.mdx)
- [TaxRate](../../tax_models/classes/tax_models.TaxRate/page.mdx)
- [TaxRateRule](../../tax_models/classes/tax_models.TaxRateRule/page.mdx)
- [TaxRegion](../../tax_models/classes/tax_models.TaxRegion/page.mdx)
- [TaxProvider](../../tax_models/variables/tax_models.TaxProvider/page.mdx)
- [TaxRate](../../tax_models/variables/tax_models.TaxRate/page.mdx)
- [TaxRateRule](../../tax_models/variables/tax_models.TaxRateRule/page.mdx)
- [TaxRegion](../../tax_models/variables/tax_models.TaxRegion/page.mdx)
www/apps/resources/references/modules/types/page.mdx
+5
View File
@@ -238,6 +238,10 @@ import { TypeList } from "docs-ui"
- [CartLikeWithTotals](../../types/types/types.CartLikeWithTotals/page.mdx)
- [CleanupObject](../../types/types/types.CleanupObject/page.mdx)
- [CleanupObject](../../types/types/types.CleanupObject-1/page.mdx)
- [CreateCalculatedShippingOptionInput](../../types/types/types.CreateCalculatedShippingOptionInput/page.mdx)
- [CreateFlatRateShippingOptionInput](../../types/types/types.CreateFlatRateShippingOptionInput/page.mdx)
- [CreateFlatRateShippingOptionPriceRecord](../../types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx)
- [CreateFlatShippingOptionInputBase](../../types/types/types.CreateFlatShippingOptionInputBase/page.mdx)
- [CreateProductVariantWorkflowInputDTO](../../types/types/types.CreateProductVariantWorkflowInputDTO/page.mdx)
- [CreateProductWorkflowInputDTO](../../types/types/types.CreateProductWorkflowInputDTO/page.mdx)
- [Depth](../../types/types/types.Depth/page.mdx)
@@ -322,6 +326,7 @@ import { TypeList } from "docs-ui"
- [TypeOnly](../../types/types/types.TypeOnly-1/page.mdx)
- [TypeOnly](../../types/types/types.TypeOnly-2/page.mdx)
- [UncountableRules](../../types/types/types.UncountableRules/page.mdx)
- [UpdateFlatShippingOptionInputBase](../../types/types/types.UpdateFlatShippingOptionInputBase/page.mdx)
- [UpdateFulfillmentShippingOptionRulesWorkflowDTO](../../types/types/types.UpdateFulfillmentShippingOptionRulesWorkflowDTO/page.mdx)
- [UpdateProductVariantWorkflowInputDTO](../../types/types/types.UpdateProductVariantWorkflowInputDTO/page.mdx)
- [UpdateProductWorkflowInputDTO](../../types/types/types.UpdateProductWorkflowInputDTO/page.mdx)
www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx
+1 -1
View File
@@ -140,7 +140,7 @@ class MyNotificationProviderService extends AbstractNotificationProviderService
#### Parameters
<TypeList types={[{"name":"notification","type":"[ProviderSendNotificationDTO](../../../types/NotificationTypes/interfaces/types.NotificationTypes.ProviderSendNotificationDTO/page.mdx)","description":"The details of the\nnotification to send.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"to","type":"`string`","description":"The recipient of the notification. It can be email, phone number, or username, depending on the channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel through which the notification is sent, such as 'email' or 'sms'","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"The template name in the provider's system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"from","type":"`null` \\| `string`","description":"The sender of the notification. It can be email, phone number, or username, depending on the channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attachments","type":"`null` \\| [Attachment](../../../types/NotificationTypes/interfaces/types.NotificationTypes.Attachment/page.mdx)[]","description":"Optional attachments for the notification.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"content","type":"`string`","description":"The content of the attachment, encoded as a base64 string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"The filename of the attachment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content_type","type":"`string`","description":"The MIME type of the attachment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"disposition","type":"`string`","description":"The disposition of the attachment, e.g., \"inline\" or \"attachment\".","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID, if the attachment is meant to be referenced within the body of the message.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data that gets passed over to the provider for rendering the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`null` \\| [NotificationContent](../../../types/NotificationTypes/interfaces/types.NotificationTypes.NotificationContent/page.mdx)","description":"The content that gets passed to the provider.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"subject","type":"`string`","description":"the subject of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"text","type":"`string`","description":"the text content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"html","type":"`string`","description":"the html content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="send"/>
<TypeList types={[{"name":"notification","type":"[ProviderSendNotificationDTO](../../../types/NotificationTypes/interfaces/types.NotificationTypes.ProviderSendNotificationDTO/page.mdx)","description":"The details of the\nnotification to send.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"to","type":"`string`","description":"The recipient of the notification. It can be email, phone number, or username, depending on the channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"channel","type":"`string`","description":"The channel through which the notification is sent, such as 'email' or 'sms'","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"template","type":"`string`","description":"The template name in the provider's system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"from","type":"`null` \\| `string`","description":"The sender of the notification. It can be email, phone number, or username, depending on the channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attachments","type":"`null` \\| [Attachment](../../../types/NotificationTypes/interfaces/types.NotificationTypes.Attachment/page.mdx)[]","description":"Optional attachments for the notification.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"content","type":"`string`","description":"The content of the attachment, encoded as a base64 string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"The filename of the attachment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content_type","type":"`string`","description":"The MIME type of the attachment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"disposition","type":"`string`","description":"The disposition of the attachment, For example, \"inline\" or \"attachment\".","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID, if the attachment is meant to be referenced within the body of the message.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data that gets passed over to the provider for rendering the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`null` \\| [NotificationContent](../../../types/NotificationTypes/interfaces/types.NotificationTypes.NotificationContent/page.mdx)","description":"The content that gets passed to the provider.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"subject","type":"`string`","description":"the subject of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"text","type":"`string`","description":"the text content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"html","type":"`string`","description":"the html content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="send"/>
#### Returns
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefundReasons/page.mdx
+1 -1
View File
@@ -58,7 +58,7 @@ const refundReasons =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)","description":"The filters to apply on the retrieved refund reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"nLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)","description":"The filters to apply on the retrieved refund reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[]","description":"Filter by the description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[]","description":"Filter by the refund reason label","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](../../../interfaces/payment.FilterableRefundReasonProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[]","description":"Filter by the description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[]","description":"Filter by the refund reason label","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/pageLine truncated
## Returns
www/apps/resources/references/payment/interfaces/payment.FilterableRefundReasonProps/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
An object used to allow specifying flexible queries with and/or conditions.
<TypeList types={[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, whLine truncated
<TypeList types={[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[]","description":"Filter by the description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[]","description":"Filter by the refund reason label","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRefundReasonProps](page.mdx) \\| [BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;[FilterableRefundReasonProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[]","description":"Filter by the description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[]","description":"Filter by the refund reason label","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the refund reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`stLine truncated
www/apps/resources/references/payment_models/classes/payment_models.Capture/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Capture
sidebar_label: Capture
---
import { TypeList } from "docs-ui"
# Capture - Payment Module Data Models Reference
This documentation provides a reference to the Capture . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection&#60;[Refund](../payment_models.Refund/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReason](../payment_models.RefundReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandLine truncated
www/apps/resources/references/payment_models/classes/payment_models.Payment/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Payment
sidebar_label: Payment
---
import { TypeList } from "docs-ui"
# Payment - Payment Module Data Models Reference
This documentation provides a reference to the Payment . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection&#60;[Refund](../payment_models.Refund/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optioLine truncated
www/apps/resources/references/payment_models/classes/payment_models.PaymentCollection/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentCollection
sidebar_label: PaymentCollection
---
import { TypeList } from "docs-ui"
# PaymentCollection - Payment Module Data Models Reference
This documentation provides a reference to the PaymentCollection . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_authorized_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captured_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_captured_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_refunded_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)","description":"","optional":false,"defaultValue":"PaymentCollectionStatus.NOT_PAID","expandable":false,"children":[{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment collection is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_providers","type":"Collection&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_sessions","type":"Collection&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":fLine truncated
www/apps/resources/references/payment_models/classes/payment_models.PaymentMethodToken/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentMethodToken
sidebar_label: PaymentMethodToken
---
import { TypeList } from "docs-ui"
# PaymentMethodToken - Payment Module Data Models Reference
This documentation provides a reference to the PaymentMethodToken . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_detail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"description_detail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentMethodToken"/>
www/apps/resources/references/payment_models/classes/payment_models.PaymentProvider/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentProvider
sidebar_label: PaymentProvider
---
import { TypeList } from "docs-ui"
# PaymentProvider - Payment Module Data Models Reference
This documentation provides a reference to the PaymentProvider . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentProvider"/>
www/apps/resources/references/payment_models/classes/payment_models.PaymentSession/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentSession
sidebar_label: PaymentSession
---
import { TypeList } from "docs-ui"
# PaymentSession - Payment Module Data Models Reference
This documentation provides a reference to the PaymentSession . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"context","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)","description":"","optional":false,"defaultValue":"PaymentSessionStatus.PENDING","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CAPTURED","type":"`\"captured\"`","description":"The payment is captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PENDING","type":"`\"pending\"`","description":"The payment is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_MORE","type":"`\"requires_more\"`","description":"The payment requires an action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ERROR","type":"`\"error\"`","description":"An error occurred while processing the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../payment_models.PaymentCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_authorized_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captured_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_captured_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_refunded_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":Line truncated
www/apps/resources/references/payment_models/classes/payment_models.Refund/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Refund
sidebar_label: Refund
---
import { TypeList } from "docs-ui"
# Refund - Payment Module Data Models Reference
This documentation provides a reference to the Refund . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection&#60;[Refund](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReason](../payment_models.RefundReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]Line truncated
www/apps/resources/references/payment_models/classes/payment_models.RefundReason/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/RefundReason
sidebar_label: RefundReason
---
import { TypeList } from "docs-ui"
# RefundReason - Payment Module Data Models Reference
This documentation provides a reference to the RefundReason . This belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RefundReason"/>
www/apps/resources/references/payment_models/variables/payment_models.Capture/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Capture
sidebar_label: Capture
---
import { TypeList } from "docs-ui"
# Capture - Payment Module Data Models Reference
This documentation provides a reference to the Capture data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The captured amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","tyLine truncated
www/apps/resources/references/payment_models/variables/payment_models.Payment/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Payment
sidebar_label: Payment
---
import { TypeList } from "docs-ui"
# Payment - Payment Module Data Models Reference
This documentation provides a reference to the Payment data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne&#60;[PaymentLine truncated
www/apps/resources/references/payment_models/variables/payment_models.PaymentCollection/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentCollection
sidebar_label: PaymentCollection
---
import { TypeList } from "docs-ui"
# PaymentCollection - Payment Module Data Models Reference
This documentation provides a reference to the PaymentCollection data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"TLine truncated
www/apps/resources/references/payment_models/variables/payment_models.PaymentMethodToken/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentMethodToken
sidebar_label: PaymentMethodToken
---
import { TypeList } from "docs-ui"
# PaymentMethodToken - Payment Module Data Models Reference
This documentation provides a reference to the PaymentMethodToken data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment method token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider this token belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the associated saved payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment method token useful for retrieving the payment details from the third-party service.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_detail","type":"`TextProperty`","description":"The details of the saved payment method's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description_detail","type":"`TextProperty`","description":"The details of the saved payment method's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentMethodToken"/>
www/apps/resources/references/payment_models/variables/payment_models.PaymentProvider/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentProvider
sidebar_label: PaymentProvider
---
import { TypeList } from "docs-ui"
# PaymentProvider - Payment Module Data Models Reference
This documentation provides a reference to the PaymentProvider data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.PLine truncated
www/apps/resources/references/payment_models/variables/payment_models.PaymentSession/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/PaymentSession
sidebar_label: PaymentSession
---
import { TypeList } from "docs-ui"
# PaymentSession - Payment Module Data Models Reference
This documentation provides a reference to the PaymentSession data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)&#62;","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/paLine truncated
www/apps/resources/references/payment_models/variables/payment_models.Refund/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/Refund
sidebar_label: Refund
---
import { TypeList } from "docs-ui"
# Refund - Payment Module Data Models Reference
This documentation provides a reference to the Refund data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)&#62;","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany&#60;[PaymentProvider](../payment_models.PaymentProvider/page.mdx)&#62;","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","typLine truncated
www/apps/resources/references/payment_models/variables/payment_models.RefundReason/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentModelReference
slug: /references/payment/models/RefundReason
sidebar_label: RefundReason
---
import { TypeList } from "docs-ui"
# RefundReason - Payment Module Data Models Reference
This documentation provides a reference to the RefundReason data model. It belongs to the Payment Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo&#60;[Payment](../payment_models.Payment/page.mdx)&#62;","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo&#60;[PaymentCollection](../payment_models.PaymentCollection/page.mdx)&#62;","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_session","type":"BelongsTo&#60;[PaymentSession](../payment_models.PaymentSession/page.mdx)&#62;","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"captures","type":"HasMany&#60;[Capture](../payment_models.Capture/page.mdx)&#62;","description":"The associated captures.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`TextProperty`","description":"The ID of the cart this payment was created for","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`TextProperty`","description":"The ID of the order this payment was created for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer making the payment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`DateTimeProperty`","description":"The date that the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`DateTimeProperty`","description":"The date that the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refund_reason","type":"BelongsTo&#60;[RefundReason](page.mdx)&#62;","description":"The associated refund reason.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany&#60;[Refund](../payment_models.Refund/page.mdx)&#62;","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"deLine truncated
www/apps/resources/references/promotion_models/classes/promotion_models.ApplicationMethod/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/ApplicationMethod
sidebar_label: ApplicationMethod
---
import { TypeList } from "docs-ui"
# ApplicationMethod - Promotion Module Data Models Reference
This documentation provides a reference to the ApplicationMethod . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"[Promotion](../promotion_models.Promotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `\"budget\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../.Line truncated
www/apps/resources/references/promotion_models/classes/promotion_models.Campaign/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/Campaign
sidebar_label: Campaign
---
import { TypeList } from "docs-ui"
# Campaign - Promotion Module Data Models Reference
This documentation provides a reference to the Campaign . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `\"budget\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`Line truncated
www/apps/resources/references/promotion_models/classes/promotion_models.CampaignBudget/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/CampaignBudget
sidebar_label: CampaignBudget
---
import { TypeList } from "docs-ui"
# CampaignBudget - Promotion Module Data Models Reference
This documentation provides a reference to the CampaignBudget . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection&#60;[PromotionRule](../promotion_models.PromotionRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,Line truncated
www/apps/resources/references/promotion_models/classes/promotion_models.Promotion/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/Promotion
sidebar_label: Promotion
---
import { TypeList } from "docs-ui"
# Promotion - Promotion Module Data Models Reference
This documentation provides a reference to the Promotion . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection&#60;[Promotion](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection&#60;[PromotionRule](../promotion_models.PromotionRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"",Line truncated
www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRule/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/PromotionRule
sidebar_label: PromotionRule
---
import { TypeList } from "docs-ui"
# PromotionRule - Promotion Module Data Models Reference
This documentation provides a reference to the PromotionRule . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_target_rules","type":"Collection&#60;[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_buy_rules","type":"Collection&#60;[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `OptionalRelations`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`nLine truncated
www/apps/resources/references/promotion_models/classes/promotion_models.PromotionRuleValue/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: promotionModelReference
slug: /references/promotion/models/PromotionRuleValue
sidebar_label: PromotionRuleValue
---
import { TypeList } from "docs-ui"
# PromotionRuleValue - Promotion Module Data Models Reference
This documentation provides a reference to the PromotionRuleValue . This belongs to the Promotion Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](../promotion_models.PromotionRule/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection&#60;[PromotionRuleValue](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](../promotion_models.PromotionRule/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection&#60;[Promotion](../promotion_models.Promotion/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection&#60;[PromotionRule](../promotion_models.PromotionRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `OptionalRelations`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"method_target_rules","type":"Collection&#60;[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues]Line truncated
Loaded 100 of 196 files, more files were not shown because too many files have changed in this diff. Show more