docs: added express checkout guide (#10810)

* initial draft

* docs: add express checkout guide

* fix lint errors

* small fixes

* add screenshot in summary

* add meta image
This commit is contained in:
Shahed Nasser
2025-02-12 14:10:37 +02:00
committed by GitHub
parent a039dd6932
commit b3604ef862
20 changed files with 2973 additions and 25 deletions
+1
View File
@@ -156,6 +156,7 @@ export default [
"@typescript-eslint/no-non-null-asserted-optional-chain": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-unused-expressions": "warn",
"@typescript-eslint/no-require-imports": "off",
},
},
]
File diff suppressed because it is too large Load Diff
@@ -5756,6 +5756,7 @@ export const generatedEditDates = {
"references/types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationAddressProps/page.mdx": "2025-01-13T18:05:55.410Z",
"references/types/StockLocationTypes/types/types.StockLocationTypes.UpdateStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.057Z",
"references/types/StockLocationTypes/types/types.StockLocationTypes.UpsertStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.058Z",
"app/storefront-development/guides/express-checkout/page.mdx": "2025-02-12T07:21:55.821Z",
"app/commerce-modules/inventory/inventory-kit/page.mdx": "2025-01-13T11:31:35.362Z",
"app/commerce-modules/api-key/workflows/page.mdx": "2025-01-09T13:41:46.573Z",
"app/commerce-modules/api-key/js-sdk/page.mdx": "2025-01-09T12:04:39.787Z",
@@ -1091,6 +1091,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/storefront-development/customers/third-party-login/page.mdx",
"pathname": "/storefront-development/customers/third-party-login"
},
{
"filePath": "/www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx",
"pathname": "/storefront-development/guides/express-checkout"
},
{
"filePath": "/www/apps/resources/app/storefront-development/page.mdx",
"pathname": "/storefront-development"
+106
View File
@@ -64,6 +64,24 @@ export const generatedSidebar = [
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Storefront Examples",
"autogenerate_tags": "example+storefront",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
}
]
}
]
},
@@ -1587,6 +1605,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3586,6 +3612,14 @@ export const generatedSidebar = [
"path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "importProductsWorkflow",
"path": "/references/medusa-workflows/importProductsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3780,6 +3814,14 @@ export const generatedSidebar = [
"path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "parseProductCsvStep",
"path": "/references/medusa-workflows/steps/parseProductCsvStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3809,6 +3851,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -6778,6 +6828,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -8814,6 +8872,14 @@ export const generatedSidebar = [
"path": "/references/medusa-workflows/steps/refundPaymentsStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "createPaymentAccountHolderStep",
"path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -8891,6 +8957,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -11126,6 +11200,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -13090,6 +13172,14 @@ export const generatedSidebar = [
"description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.",
"autogenerate_as_ref": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -16186,6 +16276,22 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Examples",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/storefront-development/guides/express-checkout",
"title": "Express Checkout Storefront",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -16,6 +16,17 @@ export const storefrontGuidesSidebar = [
},
],
},
{
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "category",
title: "Regions",
+4
View File
@@ -47,6 +47,10 @@ export const cart = [
"title": "Checkout Step 3: Choose Shipping Method",
"path": "/storefront-development/checkout/shipping"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "addShippingMethodToCartStep",
"path": "/references/medusa-workflows/steps/addShippingMethodToCartStep"
+6
View File
@@ -0,0 +1,6 @@
export const checkout = [
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
}
]
+6
View File
@@ -0,0 +1,6 @@
export const example = [
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
}
]
+12
View File
@@ -3,6 +3,10 @@ export const fulfillment = [
"title": "Checkout Step 3: Choose Shipping Method",
"path": "/storefront-development/checkout/shipping"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "validateAndReturnShippingMethodsDataStep",
"path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep"
@@ -223,6 +227,14 @@ export const fulfillment = [
"title": "markOrderFulfillmentAsDeliveredWorkflow",
"path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow"
},
{
"title": "parseProductCsvStep",
"path": "/references/medusa-workflows/steps/parseProductCsvStep"
},
{
"title": "importProductsWorkflow",
"path": "/references/medusa-workflows/importProductsWorkflow"
},
{
"title": "deleteShippingProfilesStep",
"path": "/references/medusa-workflows/steps/deleteShippingProfilesStep"
+27 -25
View File
@@ -1,37 +1,39 @@
export * from "./inventory.js"
export * from "./concept.js"
export * from "./query.js"
export * from "./pricing.js"
export * from "./server.js"
export * from "./sales-channel.js"
export * from "./query.js"
export * from "./tax.js"
export * from "./sales-channel.js"
export * from "./cart.js"
export * from "./storefront.js"
export * from "./order.js"
export * from "./payment.js"
export * from "./product.js"
export * from "./customer.js"
export * from "./product-category.js"
export * from "./stripe.js"
export * from "./order.js"
export * from "./fulfillment.js"
export * from "./publishable-api-key.js"
export * from "./api-key.js"
export * from "./region.js"
export * from "./step.js"
export * from "./product-collection.js"
export * from "./link.js"
export * from "./customer.js"
export * from "./auth.js"
export * from "./stock-location.js"
export * from "./workflow.js"
export * from "./pricing.js"
export * from "./user.js"
export * from "./remote-query.js"
export * from "./event-bus.js"
export * from "./logger.js"
export * from "./locking.js"
export * from "./currency.js"
export * from "./notification.js"
export * from "./js-sdk.js"
export * from "./admin.js"
export * from "./region.js"
export * from "./payment.js"
export * from "./product-collection.js"
export * from "./example.js"
export * from "./api-key.js"
export * from "./publishable-api-key.js"
export * from "./step.js"
export * from "./link.js"
export * from "./remote-query.js"
export * from "./workflow.js"
export * from "./store.js"
export * from "./checkout.js"
export * from "./locking.js"
export * from "./logger.js"
export * from "./stock-location.js"
export * from "./promotion.js"
export * from "./event-bus.js"
export * from "./user.js"
export * from "./product.js"
export * from "./notification.js"
export * from "./currency.js"
export * from "./file.js"
export * from "./product-category.js"
export * from "./admin.js"
export * from "./concept.js"
+4
View File
@@ -1,4 +1,8 @@
export const jsSdk = [
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "apiKey",
"path": "/references/js-sdk/admin/apiKey"
+8
View File
@@ -139,10 +139,18 @@ export const link = [
"title": "deleteOrderPaymentCollections",
"path": "/references/medusa-workflows/deleteOrderPaymentCollections"
},
{
"title": "markPaymentCollectionAsPaid",
"path": "/references/medusa-workflows/markPaymentCollectionAsPaid"
},
{
"title": "requestOrderEditRequestWorkflow",
"path": "/references/medusa-workflows/requestOrderEditRequestWorkflow"
},
{
"title": "createPaymentSessionsWorkflow",
"path": "/references/medusa-workflows/createPaymentSessionsWorkflow"
},
{
"title": "createVariantPricingLinkStep",
"path": "/references/medusa-workflows/steps/createVariantPricingLinkStep"
+4
View File
@@ -3,6 +3,10 @@ export const order = [
"title": "Checkout Step 5: Complete Cart",
"path": "/storefront-development/checkout/complete-cart"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "completeCartWorkflow",
"path": "/references/medusa-workflows/completeCartWorkflow"
+8
View File
@@ -15,6 +15,10 @@ export const payment = [
"title": "Payment with Stripe in React Storefront",
"path": "/storefront-development/checkout/payment/stripe"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "createPaymentCollectionsStep",
"path": "/references/medusa-workflows/steps/createPaymentCollectionsStep"
@@ -135,6 +139,10 @@ export const payment = [
"title": "refundPaymentsWorkflow",
"path": "/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "createPaymentAccountHolderStep",
"path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep"
},
{
"title": "createPaymentSessionStep",
"path": "/references/medusa-workflows/steps/createPaymentSessionStep"
+4
View File
@@ -11,6 +11,10 @@ export const product = [
"title": "Get Variant Price with Taxes",
"path": "/commerce-modules/product/guides/price-with-taxes"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "List Product Categories in Storefront",
"path": "/storefront-development/products/categories/list"
+8
View File
@@ -99,6 +99,10 @@ export const query = [
"title": "batchProductsWorkflow",
"path": "/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createProductsWorkflow",
"path": "/references/medusa-workflows/createProductsWorkflow"
},
{
"title": "deleteProductVariantsWorkflow",
"path": "/references/medusa-workflows/deleteProductVariantsWorkflow"
@@ -107,6 +111,10 @@ export const query = [
"title": "deleteProductsWorkflow",
"path": "/references/medusa-workflows/deleteProductsWorkflow"
},
{
"title": "deleteShippingProfileWorkflow",
"path": "/references/medusa-workflows/deleteShippingProfileWorkflow"
},
{
"title": "updateStockLocationsWorkflow",
"path": "/references/medusa-workflows/updateStockLocationsWorkflow"
+4
View File
@@ -1,4 +1,8 @@
export const region = [
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "Region Context in Storefront",
"path": "/storefront-development/regions/context"
+12
View File
@@ -143,6 +143,10 @@ export const step = [
"title": "validateLineItemPricesStep",
"path": "/references/medusa-workflows/steps/validateLineItemPricesStep"
},
{
"title": "validateShippingStep",
"path": "/references/medusa-workflows/steps/validateShippingStep"
},
{
"title": "validateVariantPricesStep",
"path": "/references/medusa-workflows/steps/validateVariantPricesStep"
@@ -851,6 +855,10 @@ export const step = [
"title": "validateRefundStep",
"path": "/references/medusa-workflows/validateRefundStep"
},
{
"title": "createPaymentAccountHolderStep",
"path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep"
},
{
"title": "createPaymentSessionStep",
"path": "/references/medusa-workflows/steps/createPaymentSessionStep"
@@ -1187,6 +1195,10 @@ export const step = [
"title": "deleteShippingProfilesStep",
"path": "/references/medusa-workflows/steps/deleteShippingProfilesStep"
},
{
"title": "validateStepShippingProfileDelete",
"path": "/references/medusa-workflows/validateStepShippingProfileDelete"
},
{
"title": "createStockLocations",
"path": "/references/medusa-workflows/steps/createStockLocations"
+4
View File
@@ -83,6 +83,10 @@ export const storefront = [
"title": "Third-Party or Social Login in Storefront",
"path": "/storefront-development/customers/third-party-login"
},
{
"title": "Implement Express Checkout with Medusa",
"path": "/storefront-development/guides/express-checkout"
},
{
"title": "List Product Categories in Storefront",
"path": "/storefront-development/products/categories/list"