docs: add inventory kit conceptual guide (#10891)

This commit is contained in:
Shahed Nasser
2025-01-09 11:59:52 +02:00
committed by GitHub
parent 28febfc643
commit 3ee15f3b85
28 changed files with 664 additions and 34 deletions
+1 -1
View File
@@ -16,7 +16,7 @@ export const auth = [
"path": "/storefront-development/customers/reset-password"
},
{
"title": "Retrieve Customer in Storefront",
"title": "Retrieve Logged-In Customer in Storefront",
"path": "/storefront-development/customers/retrieve"
},
{
+4
View File
@@ -99,6 +99,10 @@ export const cart = [
"title": "addToCartWorkflow",
"path": "/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
+6
View File
@@ -0,0 +1,6 @@
export const concept = [
{
"title": "Inventory Kits",
"path": "/commerce-modules/inventory/inventory-kit"
}
]
+1 -1
View File
@@ -28,7 +28,7 @@ export const customer = [
"path": "/storefront-development/customers/reset-password"
},
{
"title": "Retrieve Customer in Storefront",
"title": "Retrieve Logged-In Customer in Storefront",
"path": "/storefront-development/customers/retrieve"
},
{
+4
View File
@@ -11,6 +11,10 @@ export const eventBus = [
"title": "addToCartWorkflow",
"path": "/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
+22 -21
View File
@@ -1,36 +1,37 @@
export * from "./product.js"
export * from "./inventory.js"
export * from "./query.js"
export * from "./pricing.js"
export * from "./server.js"
export * from "./tax.js"
export * from "./storefront.js"
export * from "./payment.js"
export * from "./order.js"
export * from "./cart.js"
export * from "./stripe.js"
export * from "./server.js"
export * from "./product-category.js"
export * from "./auth.js"
export * from "./tax.js"
export * from "./inventory.js"
export * from "./fulfillment.js"
export * from "./order.js"
export * from "./customer.js"
export * from "./product-collection.js"
export * from "./fulfillment.js"
export * from "./region.js"
export * from "./product-category.js"
export * from "./auth.js"
export * from "./api-key.js"
export * from "./query.js"
export * from "./sales-channel.js"
export * from "./remote-link.js"
export * from "./publishable-api-key.js"
export * from "./step.js"
export * from "./workflow.js"
export * from "./file.js"
export * from "./locking.js"
export * from "./stock-location.js"
export * from "./concept.js"
export * from "./sales-channel.js"
export * from "./product.js"
export * from "./step.js"
export * from "./link.js"
export * from "./remote-query.js"
export * from "./region.js"
export * from "./workflow.js"
export * from "./store.js"
export * from "./user.js"
export * from "./promotion.js"
export * from "./currency.js"
export * from "./event-bus.js"
export * from "./logger.js"
export * from "./user.js"
export * from "./notification.js"
export * from "./file.js"
export * from "./js-sdk.js"
export * from "./admin.js"
export * from "./promotion.js"
export * from "./remote-query.js"
export * from "./notification.js"
export * from "./currency.js"
export * from "./locking.js"
+8
View File
@@ -1,4 +1,8 @@
export const inventory = [
{
"title": "Inventory Kits",
"path": "/commerce-modules/inventory/inventory-kit"
},
{
"title": "Retrieve Product Variant's Inventory in Storefront",
"path": "/storefront-development/products/inventory"
@@ -15,6 +19,10 @@ export const inventory = [
"title": "addToCartWorkflow",
"path": "/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "confirmVariantInventoryWorkflow",
"path": "/references/medusa-workflows/confirmVariantInventoryWorkflow"
@@ -1,4 +1,4 @@
export const remoteLink = [
export const link = [
{
"title": "linkSalesChannelsToApiKeyStep",
"path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep"
@@ -15,6 +15,10 @@ export const remoteLink = [
"title": "updateCartPromotionsStep",
"path": "/references/medusa-workflows/steps/updateCartPromotionsStep"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
+4
View File
@@ -3,6 +3,10 @@ export const locking = [
"title": "reserveInventoryStep",
"path": "/references/medusa-workflows/steps/reserveInventoryStep"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "confirmClaimRequestWorkflow",
"path": "/references/medusa-workflows/confirmClaimRequestWorkflow"
+12
View File
@@ -1,4 +1,8 @@
export const logger = [
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
@@ -23,10 +27,18 @@ export const logger = [
"title": "cancelPaymentStep",
"path": "/references/medusa-workflows/steps/cancelPaymentStep"
},
{
"title": "refundPaymentsStep",
"path": "/references/medusa-workflows/steps/refundPaymentsStep"
},
{
"title": "processPaymentWorkflow",
"path": "/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "deletePaymentSessionsStep",
"path": "/references/medusa-workflows/steps/deletePaymentSessionsStep"
+8
View File
@@ -3,6 +3,10 @@ export const order = [
"title": "Checkout Step 5: Complete Cart",
"path": "/storefront-development/checkout/complete-cart"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "addOrderTransactionStep",
"path": "/references/medusa-workflows/steps/addOrderTransactionStep"
@@ -467,6 +471,10 @@ export const order = [
"title": "refundPaymentWorkflow",
"path": "/references/medusa-workflows/refundPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "createReturnReasonsStep",
"path": "/references/medusa-workflows/steps/createReturnReasonsStep"
+12
View File
@@ -19,6 +19,10 @@ export const payment = [
"title": "createPaymentCollectionsStep",
"path": "/references/medusa-workflows/steps/createPaymentCollectionsStep"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
@@ -59,6 +63,10 @@ export const payment = [
"title": "refundPaymentStep",
"path": "/references/medusa-workflows/steps/refundPaymentStep"
},
{
"title": "refundPaymentsStep",
"path": "/references/medusa-workflows/steps/refundPaymentsStep"
},
{
"title": "capturePaymentWorkflow",
"path": "/references/medusa-workflows/capturePaymentWorkflow"
@@ -71,6 +79,10 @@ export const payment = [
"title": "refundPaymentWorkflow",
"path": "/references/medusa-workflows/refundPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "createPaymentSessionStep",
"path": "/references/medusa-workflows/steps/createPaymentSessionStep"
+4
View File
@@ -1,4 +1,8 @@
export const product = [
{
"title": "Inventory Kits",
"path": "/commerce-modules/inventory/inventory-kit"
},
{
"title": "Get Variant Prices",
"path": "/commerce-modules/product/guides/price"
+12
View File
@@ -59,6 +59,10 @@ export const query = [
"title": "cancelOrderTransferRequestWorkflow",
"path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow"
},
{
"title": "cancelOrderWorkflow",
"path": "/references/medusa-workflows/cancelOrderWorkflow"
},
{
"title": "declineOrderTransferRequestWorkflow",
"path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow"
@@ -71,6 +75,10 @@ export const query = [
"title": "processPaymentWorkflow",
"path": "/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "batchProductVariantsWorkflow",
"path": "/references/medusa-workflows/batchProductVariantsWorkflow"
@@ -86,5 +94,9 @@ export const query = [
{
"title": "deleteProductsWorkflow",
"path": "/references/medusa-workflows/deleteProductsWorkflow"
},
{
"title": "updateStockLocationsWorkflow",
"path": "/references/medusa-workflows/updateStockLocationsWorkflow"
}
]
+4 -4
View File
@@ -15,6 +15,10 @@ export const remoteQuery = [
"title": "addToCartWorkflow",
"path": "/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "/references/medusa-workflows/createCartWorkflow"
@@ -147,10 +151,6 @@ export const remoteQuery = [
"title": "cancelOrderFulfillmentWorkflow",
"path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow"
},
{
"title": "cancelOrderWorkflow",
"path": "/references/medusa-workflows/cancelOrderWorkflow"
},
{
"title": "cancelReturnReceiveWorkflow",
"path": "/references/medusa-workflows/cancelReturnReceiveWorkflow"
+16
View File
@@ -115,6 +115,10 @@ export const step = [
"title": "updateLineItemsStep",
"path": "/references/medusa-workflows/steps/updateLineItemsStep"
},
{
"title": "validateCartPaymentsStep",
"path": "/references/medusa-workflows/steps/validateCartPaymentsStep"
},
{
"title": "validateCartShippingOptionsStep",
"path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep"
@@ -795,6 +799,14 @@ export const step = [
"title": "refundPaymentStep",
"path": "/references/medusa-workflows/steps/refundPaymentStep"
},
{
"title": "refundPaymentsStep",
"path": "/references/medusa-workflows/steps/refundPaymentsStep"
},
{
"title": "validatePaymentsRefundStep",
"path": "/references/medusa-workflows/validatePaymentsRefundStep"
},
{
"title": "validateRefundStep",
"path": "/references/medusa-workflows/validateRefundStep"
@@ -1179,6 +1191,10 @@ export const step = [
"title": "updateTaxRatesStep",
"path": "/references/medusa-workflows/steps/updateTaxRatesStep"
},
{
"title": "updateTaxRegionsStep",
"path": "/references/medusa-workflows/steps/updateTaxRegionsStep"
},
{
"title": "createUsersStep",
"path": "/references/medusa-workflows/steps/createUsersStep"
@@ -1,4 +1,8 @@
export const stockLocation = [
{
"title": "Inventory Kits",
"path": "/commerce-modules/inventory/inventory-kit"
},
{
"title": "createStockLocations",
"path": "/references/medusa-workflows/steps/createStockLocations"
+1 -1
View File
@@ -76,7 +76,7 @@ export const storefront = [
"path": "/storefront-development/customers/reset-password"
},
{
"title": "Retrieve Customer in Storefront",
"title": "Retrieve Logged-In Customer in Storefront",
"path": "/storefront-development/customers/retrieve"
},
{
+8
View File
@@ -87,6 +87,10 @@ export const tax = [
"title": "updateTaxRatesStep",
"path": "/references/medusa-workflows/steps/updateTaxRatesStep"
},
{
"title": "updateTaxRegionsStep",
"path": "/references/medusa-workflows/steps/updateTaxRegionsStep"
},
{
"title": "createTaxRateRulesWorkflow",
"path": "/references/medusa-workflows/createTaxRateRulesWorkflow"
@@ -119,6 +123,10 @@ export const tax = [
"title": "updateTaxRatesWorkflow",
"path": "/references/medusa-workflows/updateTaxRatesWorkflow"
},
{
"title": "updateTaxRegionsWorkflow",
"path": "/references/medusa-workflows/updateTaxRegionsWorkflow"
},
{
"title": "taxRate",
"path": "/references/js-sdk/admin/taxRate"
+4
View File
@@ -627,6 +627,10 @@ export const workflow = [
"title": "refundPaymentWorkflow",
"path": "/references/medusa-workflows/refundPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "createPaymentSessionsWorkflow",
"path": "/references/medusa-workflows/createPaymentSessionsWorkflow"