Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Add documentation v5 and v4 switcher, add v5 specific API endpoints
Damian Legawiecb86df0d3a6d2
diff --git a/docs/api-reference/platform/cms-pages/create-a-cms-page.mdx b/docs/api-reference/platform/cms-pages/create-a-cms-page.mdxindex 5c142b4bbd..a48b646d71 100644--- a/docs/api-reference/platform/cms-pages/create-a-cms-page.mdx+++ b/docs/api-reference/platform/cms-pages/create-a-cms-page.mdx@@ -1,3 +1,4 @@---openapi: post /api/v2/platform/cms_pages+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-pages/delete-a-cms-page.mdx b/docs/api-reference/platform/cms-pages/delete-a-cms-page.mdxindex 2bd63112ee..7340eebda6 100644--- a/docs/api-reference/platform/cms-pages/delete-a-cms-page.mdx+++ b/docs/api-reference/platform/cms-pages/delete-a-cms-page.mdx@@ -1,3 +1,4 @@---openapi: delete /api/v2/platform/cms_pages/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-pages/return-a-cms-page.mdx b/docs/api-reference/platform/cms-pages/return-a-cms-page.mdxindex f2bf590455..f62e39ee8a 100644--- a/docs/api-reference/platform/cms-pages/return-a-cms-page.mdx+++ b/docs/api-reference/platform/cms-pages/return-a-cms-page.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/cms_pages/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-pages/return-a-list-of-cms-pages.mdx b/docs/api-reference/platform/cms-pages/return-a-list-of-cms-pages.mdxindex 11407fe3d9..4a43fb8a33 100644--- a/docs/api-reference/platform/cms-pages/return-a-list-of-cms-pages.mdx+++ b/docs/api-reference/platform/cms-pages/return-a-list-of-cms-pages.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/cms_pages+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-pages/update-a-cms-page.mdx b/docs/api-reference/platform/cms-pages/update-a-cms-page.mdxindex 1d9fe4fbf1..a63ae9154c 100644--- a/docs/api-reference/platform/cms-pages/update-a-cms-page.mdx+++ b/docs/api-reference/platform/cms-pages/update-a-cms-page.mdx@@ -1,3 +1,4 @@---openapi: patch /api/v2/platform/cms_pages/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-sections/create-a-cms-section.mdx b/docs/api-reference/platform/cms-sections/create-a-cms-section.mdxindex 85ffe828ca..8bd5a9766c 100644--- a/docs/api-reference/platform/cms-sections/create-a-cms-section.mdx+++ b/docs/api-reference/platform/cms-sections/create-a-cms-section.mdx@@ -1,3 +1,4 @@---openapi: post /api/v2/platform/cms_sections+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-sections/delete-a-cms-section.mdx b/docs/api-reference/platform/cms-sections/delete-a-cms-section.mdxindex c189424e89..d2b99c6a33 100644--- a/docs/api-reference/platform/cms-sections/delete-a-cms-section.mdx+++ b/docs/api-reference/platform/cms-sections/delete-a-cms-section.mdx@@ -1,3 +1,4 @@---openapi: delete /api/v2/platform/cms_sections/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-sections/return-a-cms-section.mdx b/docs/api-reference/platform/cms-sections/return-a-cms-section.mdxindex c9a312681a..3304262686 100644--- a/docs/api-reference/platform/cms-sections/return-a-cms-section.mdx+++ b/docs/api-reference/platform/cms-sections/return-a-cms-section.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/cms_sections/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-sections/return-a-list-of-cms-sections.mdx b/docs/api-reference/platform/cms-sections/return-a-list-of-cms-sections.mdxindex 9022b5e3d1..b8b73b1c10 100644--- a/docs/api-reference/platform/cms-sections/return-a-list-of-cms-sections.mdx+++ b/docs/api-reference/platform/cms-sections/return-a-list-of-cms-sections.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/cms_sections+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/cms-sections/update-a-cms-section.mdx b/docs/api-reference/platform/cms-sections/update-a-cms-section.mdxindex 75168424aa..49e287e8b4 100644--- a/docs/api-reference/platform/cms-sections/update-a-cms-section.mdx+++ b/docs/api-reference/platform/cms-sections/update-a-cms-section.mdx@@ -1,3 +1,4 @@---openapi: patch /api/v2/platform/cms_sections/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/create-a-menu-item.mdx b/docs/api-reference/platform/menu-items/create-a-menu-item.mdxindex 90d0f45591..7eac3b8839 100644--- a/docs/api-reference/platform/menu-items/create-a-menu-item.mdx+++ b/docs/api-reference/platform/menu-items/create-a-menu-item.mdx@@ -1,3 +1,4 @@---openapi: post /api/v2/platform/menu_items+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/delete-a-menu-item.mdx b/docs/api-reference/platform/menu-items/delete-a-menu-item.mdxindex 4b0cc14f21..c386b1a3fb 100644--- a/docs/api-reference/platform/menu-items/delete-a-menu-item.mdx+++ b/docs/api-reference/platform/menu-items/delete-a-menu-item.mdx@@ -1,3 +1,4 @@---openapi: delete /api/v2/platform/menu_items/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/reposition-a-menu-item.mdx b/docs/api-reference/platform/menu-items/reposition-a-menu-item.mdxindex a3fa798aea..0ff11a8ada 100644--- a/docs/api-reference/platform/menu-items/reposition-a-menu-item.mdx+++ b/docs/api-reference/platform/menu-items/reposition-a-menu-item.mdx@@ -1,3 +1,4 @@---openapi: patch /api/v2/platform/menu_items/{id}/reposition+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/return-a-list-of-menu-items.mdx b/docs/api-reference/platform/menu-items/return-a-list-of-menu-items.mdxindex 2e8fb31dc2..e404710aa1 100644--- a/docs/api-reference/platform/menu-items/return-a-list-of-menu-items.mdx+++ b/docs/api-reference/platform/menu-items/return-a-list-of-menu-items.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/menu_items+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/return-a-menu-item.mdx b/docs/api-reference/platform/menu-items/return-a-menu-item.mdxindex f8f4452329..d8ec1ddf31 100644--- a/docs/api-reference/platform/menu-items/return-a-menu-item.mdx+++ b/docs/api-reference/platform/menu-items/return-a-menu-item.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/menu_items/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menu-items/update-a-menu-item.mdx b/docs/api-reference/platform/menu-items/update-a-menu-item.mdxindex 8eaeca1732..6c89e8dd1b 100644--- a/docs/api-reference/platform/menu-items/update-a-menu-item.mdx+++ b/docs/api-reference/platform/menu-items/update-a-menu-item.mdx@@ -1,3 +1,4 @@---openapi: patch /api/v2/platform/menu_items/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menus/create-a-menu.mdx b/docs/api-reference/platform/menus/create-a-menu.mdxindex c2a2a98fb7..b7cbd90d9e 100644--- a/docs/api-reference/platform/menus/create-a-menu.mdx+++ b/docs/api-reference/platform/menus/create-a-menu.mdx@@ -1,3 +1,4 @@---openapi: post /api/v2/platform/menus+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menus/delete-a-menu.mdx b/docs/api-reference/platform/menus/delete-a-menu.mdxindex c878f25ae0..3db9129a21 100644--- a/docs/api-reference/platform/menus/delete-a-menu.mdx+++ b/docs/api-reference/platform/menus/delete-a-menu.mdx@@ -1,3 +1,4 @@---openapi: delete /api/v2/platform/menus/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menus/return-a-list-of-menus.mdx b/docs/api-reference/platform/menus/return-a-list-of-menus.mdxindex ff329cdd8d..40fa43ec45 100644--- a/docs/api-reference/platform/menus/return-a-list-of-menus.mdx+++ b/docs/api-reference/platform/menus/return-a-list-of-menus.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/menus+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menus/return-a-menu.mdx b/docs/api-reference/platform/menus/return-a-menu.mdxindex 3693effd96..3b5d0107c6 100644--- a/docs/api-reference/platform/menus/return-a-menu.mdx+++ b/docs/api-reference/platform/menus/return-a-menu.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/platform/menus/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/platform/menus/update-a-menu.mdx b/docs/api-reference/platform/menus/update-a-menu.mdxindex f8516c9341..150cb37423 100644--- a/docs/api-reference/platform/menus/update-a-menu.mdx+++ b/docs/api-reference/platform/menus/update-a-menu.mdx@@ -1,3 +1,4 @@---openapi: patch /api/v2/platform/menus/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/storefront.yaml b/docs/api-reference/storefront.yamlindex 49011825b0..fdfc1ba4dc 100644--- a/docs/api-reference/storefront.yaml+++ b/docs/api-reference/storefront.yaml@@ -1197,7 +1197,7 @@ paths:schema:type: stringexample: 'bb492c7d-c174-4e6b-ba0b-fe98d5c17307,51c35adb-7ab3-4880-8887-35bdc4f6c29f'- description: 'Fetch products from specified Vendors (Sellers) only'+ description: 'Fetch products from specified Vendors (Sellers) - only available in [Enterprise Edition](https://spreecommerce.org/pricing)'- in: queryname: 'filter[name]'schema:@@ -1637,8 +1637,8 @@ paths:$ref: '#/components/responses/422UnprocessableEntity'/api/v2/storefront/vendors:get:- description: 'Returns a list of Vendors.'- summary: List all Vendors available on this Store / Marketplace.+ summary: List all Vendors+ description: 'Returns a list of Vendors. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)'tags:- VendorsoperationId: vendors-list@@ -1651,7 +1651,7 @@ paths:$ref: '#/components/responses/VendorList''/api/v2/storefront/vendors/{vendor_slug}':get:- description: Returns the details of a specified Vendor.+ description: Returns the details of a specified Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)summary: Retrieve a Vendortags:- Vendorsdiff --git a/docs/api-reference/storefront/checkout/validate-order-payment.mdx b/docs/api-reference/storefront/checkout/validate-order-payment.mdxnew file mode 100644index 0000000000..be3b9d2e1e--- /dev/null+++ b/docs/api-reference/storefront/checkout/validate-order-payment.mdx@@ -0,0 +1,4 @@+---+openapi: post /api/v2/storefront/checkout/validate_order_for_payment+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/cms-pages/list-all-cms-pages.mdx b/docs/api-reference/storefront/cms-pages/list-all-cms-pages.mdxindex 78d1ac6dd5..ccd1d478e1 100644--- a/docs/api-reference/storefront/cms-pages/list-all-cms-pages.mdx+++ b/docs/api-reference/storefront/cms-pages/list-all-cms-pages.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/storefront/cms_pages+version: v4---\ No newline at end of filediff --git a/docs/api-reference/storefront/cms-pages/retrieve-a-cms-page.mdx b/docs/api-reference/storefront/cms-pages/retrieve-a-cms-page.mdxindex 966c7abbdc..5d4d8d5159 100644--- a/docs/api-reference/storefront/cms-pages/retrieve-a-cms-page.mdx+++ b/docs/api-reference/storefront/cms-pages/retrieve-a-cms-page.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/storefront/cms_pages/{cms_page_slug}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/storefront/menus/list-all-menus.mdx b/docs/api-reference/storefront/menus/list-all-menus.mdxindex 935d30faaa..1d8c8ecaec 100644--- a/docs/api-reference/storefront/menus/list-all-menus.mdx+++ b/docs/api-reference/storefront/menus/list-all-menus.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/storefront/menus+version: v4---\ No newline at end of filediff --git a/docs/api-reference/storefront/menus/retrieve-a-menu.mdx b/docs/api-reference/storefront/menus/retrieve-a-menu.mdxindex 52a1b82240..2e206f1cda 100644--- a/docs/api-reference/storefront/menus/retrieve-a-menu.mdx+++ b/docs/api-reference/storefront/menus/retrieve-a-menu.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/storefront/menus/{id}+version: v4---\ No newline at end of filediff --git a/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdxnew file mode 100644index 0000000000..ce4ef32510--- /dev/null+++ b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent-1.mdx@@ -0,0 +1,4 @@+---+openapi: patch /api/v2/storefront/stripe/payment_intents+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent.mdx b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent.mdxnew file mode 100644index 0000000000..4a3ff3ed27--- /dev/null+++ b/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent.mdx@@ -0,0 +1,4 @@+---+openapi: post /api/v2/storefront/stripe/payment_intents+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/stripe/create-a-stripe-setup-intent.mdx b/docs/api-reference/storefront/stripe/create-a-stripe-setup-intent.mdxnew file mode 100644index 0000000000..8abafa9eb8--- /dev/null+++ b/docs/api-reference/storefront/stripe/create-a-stripe-setup-intent.mdx@@ -0,0 +1,4 @@+---+openapi: post /api/v2/storefront/stripe/setup_intents+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx b/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdxnew file mode 100644index 0000000000..20d83bf93f--- /dev/null+++ b/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.mdx@@ -0,0 +1,4 @@+---+openapi: get /api/v2/storefront/stripe/payment_intents+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/taxons/list-all-taxons.mdx b/docs/api-reference/storefront/taxons/list-all-taxons.mdxindex 8f38f6b04f..e78c11a7b2 100644--- a/docs/api-reference/storefront/taxons/list-all-taxons.mdx+++ b/docs/api-reference/storefront/taxons/list-all-taxons.mdx@@ -1,3 +1,4 @@---openapi: get /api/v2/storefront/taxons+version: v5---\ No newline at end of filediff --git a/docs/api-reference/storefront/variants/list-all-product-variants.mdx b/docs/api-reference/storefront/variants/list-all-product-variants.mdxnew file mode 100644index 0000000000..360566dec1--- /dev/null+++ b/docs/api-reference/storefront/variants/list-all-product-variants.mdx@@ -0,0 +1,3 @@+---+openapi: get /api/v2/storefront/products/{product_slug}/variants+---\ No newline at end of filediff --git a/docs/api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace.mdx b/docs/api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace.mdxnew file mode 100644index 0000000000..8ddfc07bb0--- /dev/null+++ b/docs/api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace.mdx@@ -0,0 +1,4 @@+---+openapi: get /api/v2/storefront/vendors+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/vendors/retrieve-a-vendor.mdx b/docs/api-reference/storefront/vendors/retrieve-a-vendor.mdxnew file mode 100644index 0000000000..fccf7d8962--- /dev/null+++ b/docs/api-reference/storefront/vendors/retrieve-a-vendor.mdx@@ -0,0 +1,4 @@+---+openapi: get /api/v2/storefront/vendors/{vendor_slug}+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/wishlists-wished-items/add-items-to-wishlist.mdx b/docs/api-reference/storefront/wishlists-wished-items/add-items-to-wishlist.mdxnew file mode 100644index 0000000000..87c1d0f2b2--- /dev/null+++ b/docs/api-reference/storefront/wishlists-wished-items/add-items-to-wishlist.mdx@@ -0,0 +1,4 @@+---+openapi: post /api/v2/storefront/wishlists/{token}/add_items+version: v5+---\ No newline at end of filediff --git a/docs/api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist.mdx b/docs/api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist.mdxnew file mode 100644index 0000000000..afb16b8726--- /dev/null+++ b/docs/api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist.mdx@@ -0,0 +1,4 @@+---+openapi: delete /api/v2/storefront/wishlists/{token}/remove_items+version: v5+---\ No newline at end of filediff --git a/docs/developer/customization/quickstart.mdx b/docs/developer/customization/quickstart.mdxindex 7f339c9031..921ceb33c8 100644--- a/docs/developer/customization/quickstart.mdx+++ b/docs/developer/customization/quickstart.mdx@@ -1,5 +1,6 @@---title: Quickstart+og:title: Spree Customization Quickstartdescription: Learn how to customize every part of the Spree stack---diff --git a/docs/mint.json b/docs/mint.jsonindex d8ce1079f5..999c5d0f95 100644--- a/docs/mint.json+++ b/docs/mint.json@@ -19,6 +19,15 @@"light": "#F3F3F3"}},+ "versions": [+ {+ "name": "v5",+ "default": true+ },+ {+ "name": "v4"+ }+ ],"api": {"baseUrl": ["http://localhost:3000", "https://demo.spreecommerce.org"]},@@ -237,7 +246,8 @@{"group": "Checkout","pages": [- "api-reference/storefront/checkout/update-checkout"+ "api-reference/storefront/checkout/update-checkout",+ "api-reference/storefront/checkout/validate-order-payment"]},{@@ -269,6 +279,15 @@"api-reference/storefront/checkout-store-credit/remove-store-credit"]},+ {+ "group": "Stripe",+ "pages": [+ "api-reference/storefront/stripe/return-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent-1",+ "api-reference/storefront/stripe/create-a-stripe-setup-intent"+ ]+ },{"group": "Products","pages": [@@ -276,6 +295,13 @@"api-reference/storefront/products/retrieve-a-product"]},+ {+ "group": "Vendors",+ "pages": [+ "api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace",+ "api-reference/storefront/vendors/retrieve-a-vendor"+ ]+ },{"group": "Stores","pages": [@@ -326,8 +352,10 @@"group": "Wishlists / Wished Items","pages": ["api-reference/storefront/wishlists-wished-items/add-item-to-wishlist",+ "api-reference/storefront/wishlists-wished-items/add-items-to-wishlist","api-reference/storefront/wishlists-wished-items/set-wished-item-quantity",- "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist"+ "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist",+ "api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist"]},{