2 "$schema": "https://mintlify.com/schema.json",
3 "name": "Spree Commerce Guides",
5 "dark": "/logo/logo_dark.png",
6 "light": "/logo/logo_light.png",
7 "href": "https://spreecommerce.org"
9 "favicon": "/favicon.png",
23 "baseUrl": ["http://localhost:3000", "https://demo.spreecommerce.org"]
26 "/api-reference/storefront.yaml",
27 "/api-reference/platform.yaml"
32 "url": "mailto:hello@spreecommerce.org"
37 "name": "Get started",
38 "url": "https://spreecommerce.org/contact/"
42 "name": "API Reference",
43 "url": "api-reference"
53 "url": "http://slack.spreecommerce.org/"
58 "url": "https://spreecommerce.org/success-stories/"
63 "url": "https://github.com/spree/spree"
68 "url": "https://spreecommerce.org/blog/"
73 "group": "Getting started",
75 "developer/getting-started/quickstart"
79 "group": "Core Concepts",
81 "developer/core-concepts/architecture",
82 "developer/core-concepts/stores",
83 "developer/core-concepts/orders",
84 "developer/core-concepts/users",
85 "developer/core-concepts/products",
86 "developer/core-concepts/inventory",
87 "developer/core-concepts/payments",
88 "developer/core-concepts/taxes",
89 "developer/core-concepts/promotions",
90 "developer/core-concepts/shipments",
91 "developer/core-concepts/addresses",
92 "developer/core-concepts/i18n"
97 "group": "Customizing Spree",
99 "developer/customization/quickstart",
100 "developer/customization/authentication",
101 "developer/customization/images",
102 "developer/customization/checkout",
103 "developer/customization/permissions",
104 "developer/customization/dependencies",
105 "developer/customization/decorators"
110 "group": "Extending Spree",
112 "developer/extending-spree/promotions",
113 "developer/extending-spree/3rd-party-extensions"
118 "group": "Upgrading",
120 "developer/upgrades/quickstart",
122 "group": "Upgrade Guides",
124 "developer/upgrades/4.6-to-4.7",
125 "developer/upgrades/4.5-to-4.6",
126 "developer/upgrades/4.4-to-4.5",
127 "developer/upgrades/4.3-to-4.4",
128 "developer/upgrades/4.2-to-4.3",
129 "developer/upgrades/4.1-to-4.2",
130 "developer/upgrades/4.0-to-4.1",
131 "developer/upgrades/3.7-to-4.0",
132 "developer/upgrades/3.6-to-3.7",
133 "developer/upgrades/3.5-to-3.6",
134 "developer/upgrades/3.4-to-3.5",
135 "developer/upgrades/3.3-to-3.4",
136 "developer/upgrades/3.2-to-3.3",
137 "developer/upgrades/3.1-to-3.2",
138 "developer/upgrades/3.0-to-3.1",
139 "developer/upgrades/2.3-to-2.4",
140 "developer/upgrades/2.2-to-2.3",
141 "developer/upgrades/2.1-to-2.2",
142 "developer/upgrades/2.0-to-2.1"
149 "group": "Contributing",
151 "developer/contributing/quickstart",
152 "developer/contributing/creating-an-extension"
157 "group": "API basics",
159 "api-reference/introduction",
160 "api-reference/pagination",
161 "api-reference/filtering-and-sorting",
162 "api-reference/fetching-multiple-resources"
166 "group": "Storefront API",
168 "api-reference/storefront/authentication",
172 "api-reference/storefront/account/retrieve-an-account",
173 "api-reference/storefront/account/create-an-account",
174 "api-reference/storefront/account/update-an-account"
178 "group": "Account / Address",
180 "api-reference/storefront/account-address/list-all-addresses",
181 "api-reference/storefront/account-address/create-an-address",
182 "api-reference/storefront/account-address/remove-an-address",
183 "api-reference/storefront/account-address/update-an-address"
187 "group": "Account / Credit Cards",
189 "api-reference/storefront/account-credit-cards/list-all-credit-cards",
190 "api-reference/storefront/account-credit-cards/remove-a-credit-card",
191 "api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card"
195 "group": "Account / Orders",
197 "api-reference/storefront/account-orders/list-all-orders",
198 "api-reference/storefront/account-orders/retrieve-an-order"
202 "group": "Order Status",
204 "api-reference/storefront/order-status/retrieve-an-order-status"
210 "api-reference/storefront/cart/retrieve-a-cart",
211 "api-reference/storefront/cart/create-a-cart",
212 "api-reference/storefront/cart/delete-a-cart"
216 "group": "Cart / Line Items",
218 "api-reference/storefront/cart-line-items/add-an-item-to-cart",
219 "api-reference/storefront/cart-line-items/set-line-item-quantity",
220 "api-reference/storefront/cart-line-items/remove-a-line-item"
224 "group": "Cart / Other",
226 "api-reference/storefront/cart-other/empty-the-cart",
227 "api-reference/storefront/cart-other/list-estimated-shipping-rates",
228 "api-reference/storefront/cart-other/associate-a-cart-with-a-user",
229 "api-reference/storefront/cart-other/change-cart-currency"
233 "group": "Cart / Coupons",
235 "api-reference/storefront/cart-coupons/apply-a-coupon-code",
236 "api-reference/storefront/cart-coupons/remove-a-coupon",
237 "api-reference/storefront/cart-coupons/remove-all-coupons"
243 "api-reference/storefront/checkout/update-checkout"
247 "group": "Checkout / State",
249 "api-reference/storefront/checkout-state/next-checkout-step",
250 "api-reference/storefront/checkout-state/advance-checkout",
251 "api-reference/storefront/checkout-state/complete-checkout"
255 "group": "Checkout / Shipments",
257 "api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments",
258 "api-reference/storefront/checkout-shipments/list-shipping-rates"
262 "group": "Checkout / Payments",
264 "api-reference/storefront/checkout-payments/create-new-payment",
265 "api-reference/storefront/checkout-payments/list-payment-methods"
269 "group": "Checkout / Store Credit",
271 "api-reference/storefront/checkout-store-credit/add-store-credit",
272 "api-reference/storefront/checkout-store-credit/remove-store-credit"
278 "api-reference/storefront/products/list-all-products",
279 "api-reference/storefront/products/retrieve-a-product"
285 "api-reference/storefront/stores/return-the-current-store"
291 "api-reference/storefront/taxons/list-all-taxons",
292 "api-reference/storefront/taxons/retrieve-a-taxon"
296 "group": "Countries",
298 "api-reference/storefront/countries/list-all-countries",
299 "api-reference/storefront/countries/retrieve-a-country",
300 "api-reference/storefront/countries/get-default-country"
304 "group": "CMS Pages",
306 "api-reference/storefront/cms-pages/list-all-cms-pages",
307 "api-reference/storefront/cms-pages/retrieve-a-cms-page"
313 "api-reference/storefront/menus/list-all-menus",
314 "api-reference/storefront/menus/retrieve-a-menu"
318 "group": "Wishlists",
320 "api-reference/storefront/wishlists/list-all-wishlists",
321 "api-reference/storefront/wishlists/create-a-wishlist",
322 "api-reference/storefront/wishlists/retrieve-a-wishlist",
323 "api-reference/storefront/wishlists/delete-a-wishlist",
324 "api-reference/storefront/wishlists/update-a-wishlist",
325 "api-reference/storefront/wishlists/retrieve-the-default-wishlist"
329 "group": "Wishlists / Wished Items",
331 "api-reference/storefront/wishlists-wished-items/add-item-to-wishlist",
332 "api-reference/storefront/wishlists-wished-items/set-wished-item-quantity",
333 "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist"
337 "group": "Digital Downloads",
339 "api-reference/storefront/digital-downloads/download-a-digital-asset"
346 "group": "Platform API",
348 "api-reference/platform/authentication",
350 "group": "Addresses",
352 "api-reference/platform/addresses/return-a-list-of-addresses",
353 "api-reference/platform/addresses/create-an-address",
354 "api-reference/platform/addresses/return-an-address",
355 "api-reference/platform/addresses/delete-an-address",
356 "api-reference/platform/addresses/update-an-address"
360 "group": "Adjustments",
362 "api-reference/platform/adjustments/return-a-list-of-adjustments",
363 "api-reference/platform/adjustments/create-an-adjustment",
364 "api-reference/platform/adjustments/return-an-adjustment",
365 "api-reference/platform/adjustments/delete-an-adjustment",
366 "api-reference/platform/adjustments/update-an-adjustment"
370 "group": "Classifications",
372 "api-reference/platform/classifications/return-a-list-of-classifications",
373 "api-reference/platform/classifications/create-a-classification",
374 "api-reference/platform/classifications/return-a-classification",
375 "api-reference/platform/classifications/delete-a-classification",
376 "api-reference/platform/classifications/update-a-classification"
380 "group": "CMS Pages",
382 "api-reference/platform/cms-pages/return-a-list-of-cms-pages",
383 "api-reference/platform/cms-pages/create-a-cms-page",
384 "api-reference/platform/cms-pages/return-a-cms-page",
385 "api-reference/platform/cms-pages/delete-a-cms-page",
386 "api-reference/platform/cms-pages/update-a-cms-page"
390 "group": "CMS Sections",
392 "api-reference/platform/cms-sections/return-a-list-of-cms-sections",
393 "api-reference/platform/cms-sections/create-a-cms-section",
394 "api-reference/platform/cms-sections/return-a-cms-section",
395 "api-reference/platform/cms-sections/delete-a-cms-section",
396 "api-reference/platform/cms-sections/update-a-cms-section"
400 "group": "Countries",
402 "api-reference/platform/countries/returns-a-list-of-countries",
403 "api-reference/platform/countries/returns-a-country"
407 "group": "Data Feeds",
409 "api-reference/platform/data-feeds/return-a-list-of-data-feeds",
410 "api-reference/platform/data-feeds/create-a-data-feed",
411 "api-reference/platform/data-feeds/return-a-data-feed",
412 "api-reference/platform/data-feeds/delete-a-data-feed",
413 "api-reference/platform/data-feeds/update-a-data-feed"
417 "group": "Digital Links",
419 "api-reference/platform/digital-links/return-a-list-of-digital-links",
420 "api-reference/platform/digital-links/create-a-digital-link",
421 "api-reference/platform/digital-links/return-a-digital-link",
422 "api-reference/platform/digital-links/delete-a-digital-link",
423 "api-reference/platform/digital-links/update-a-digital-link",
424 "api-reference/platform/digital-links/reset-a-digital-link"
428 "group": "Digital Assets",
430 "api-reference/platform/digital-assets/return-a-list-of-digital-assets",
431 "api-reference/platform/digital-assets/create-a-digital-asset",
432 "api-reference/platform/digital-assets/return-a-digital-asset",
433 "api-reference/platform/digital-assets/delete-a-digital-asset",
434 "api-reference/platform/digital-assets/update-a-digital-asset"
438 "group": "Line Items",
440 "api-reference/platform/line-items/return-a-list-of-line-items",
441 "api-reference/platform/line-items/create-a-line-item",
442 "api-reference/platform/line-items/return-a-line-item",
443 "api-reference/platform/line-items/delete-a-line-item",
444 "api-reference/platform/line-items/update-a-line-item"
448 "group": "Menu Items",
450 "api-reference/platform/menu-items/return-a-list-of-menu-items",
451 "api-reference/platform/menu-items/create-a-menu-item",
452 "api-reference/platform/menu-items/return-a-menu-item",
453 "api-reference/platform/menu-items/delete-a-menu-item",
454 "api-reference/platform/menu-items/update-a-menu-item",
455 "api-reference/platform/menu-items/reposition-a-menu-item"
461 "api-reference/platform/menus/return-a-list-of-menus",
462 "api-reference/platform/menus/create-a-menu",
463 "api-reference/platform/menus/return-a-menu",
464 "api-reference/platform/menus/delete-a-menu",
465 "api-reference/platform/menus/update-a-menu"
469 "group": "Option Types",
471 "api-reference/platform/option-types/return-a-list-of-option-types",
472 "api-reference/platform/option-types/create-an-option-type",
473 "api-reference/platform/option-types/return-an-option-type",
474 "api-reference/platform/option-types/delete-an-option-type",
475 "api-reference/platform/option-types/update-an-option-type"
479 "group": "Option Values",
481 "api-reference/platform/option-values/return-a-list-of-option-values",
482 "api-reference/platform/option-values/create-an-option-value",
483 "api-reference/platform/option-values/return-an-option-value",
484 "api-reference/platform/option-values/delete-an-option-value",
485 "api-reference/platform/option-values/update-an-option-value"
491 "api-reference/platform/orders/return-a-list-of-orders",
492 "api-reference/platform/orders/creates-an-order",
493 "api-reference/platform/orders/return-an-order",
494 "api-reference/platform/orders/delete-an-order",
495 "api-reference/platform/orders/update-an-order",
496 "api-reference/platform/orders/advances-an-order",
497 "api-reference/platform/orders/next-an-order",
498 "api-reference/platform/orders/completes-an-order",
499 "api-reference/platform/orders/empties-an-order",
500 "api-reference/platform/orders/approves-an-order",
501 "api-reference/platform/orders/cancels-an-order",
502 "api-reference/platform/orders/use-store-credit-for-an-order",
503 "api-reference/platform/orders/apply-coupon-code-for-an-order"
507 "group": "Payment Methods",
509 "api-reference/platform/payment-methods/return-a-list-of-payment-methods",
510 "api-reference/platform/payment-methods/create-a-payment-method",
511 "api-reference/platform/payment-methods/return-a-payment-method",
512 "api-reference/platform/payment-methods/delete-a-payment-method",
513 "api-reference/platform/payment-methods/update-a-payment-method"
519 "api-reference/platform/payments/return-a-list-of-payments",
520 "api-reference/platform/payments/return-a-payment",
521 "api-reference/platform/payments/delete-a-payment"
527 "api-reference/platform/products/return-a-list-of-products",
528 "api-reference/platform/products/create-a-product",
529 "api-reference/platform/products/return-a-product",
530 "api-reference/platform/products/delete-a-product",
531 "api-reference/platform/products/update-a-product"
535 "group": "Promotion Actions",
537 "api-reference/platform/promotion-actions/return-a-list-of-promotion-actions",
538 "api-reference/platform/promotion-actions/create-a-promotion-action",
539 "api-reference/platform/promotion-actions/return-a-promotion-action",
540 "api-reference/platform/promotion-actions/delete-a-promotion-action",
541 "api-reference/platform/promotion-actions/update-a-promotion-action"
545 "group": "Promotion Categories",
547 "api-reference/platform/promotion-categories/return-a-list-of-promotion-categories",
548 "api-reference/platform/promotion-categories/create-a-promotion-category",
549 "api-reference/platform/promotion-categories/return-a-promotion-category",
550 "api-reference/platform/promotion-categories/delete-a-promotion-category",
551 "api-reference/platform/promotion-categories/update-a-promotion-category"
555 "group": "Promotion Rules",
557 "api-reference/platform/promotion-rules/return-a-list-of-promotion-rules",
558 "api-reference/platform/promotion-rules/create-a-promotion-rule",
559 "api-reference/platform/promotion-rules/return-a-promotion-rule",
560 "api-reference/platform/promotion-rules/delete-a-promotion-rule",
561 "api-reference/platform/promotion-rules/update-a-promotion-rule"
565 "group": "Promotions",
567 "api-reference/platform/promotions/return-a-list-of-promotions",
568 "api-reference/platform/promotions/create-a-promotion",
569 "api-reference/platform/promotions/return-a-promotion",
570 "api-reference/platform/promotions/delete-a-promotion",
571 "api-reference/platform/promotions/update-a-promotion"
577 "api-reference/platform/roles/return-a-list-of-roles",
578 "api-reference/platform/roles/create-a-role",
579 "api-reference/platform/roles/return-a-role",
580 "api-reference/platform/roles/delete-a-role",
581 "api-reference/platform/roles/update-a-role"
585 "group": "Shipments",
587 "api-reference/platform/shipments/return-a-list-of-shipments",
588 "api-reference/platform/shipments/create-a-shipment",
589 "api-reference/platform/shipments/return-a-shipment",
590 "api-reference/platform/shipments/delete-a-shipment",
591 "api-reference/platform/shipments/update-a-shipment",
592 "api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment",
593 "api-reference/platform/shipments/removes-item-variant-from-shipment",
594 "api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped",
595 "api-reference/platform/shipments/mark-shipment-as-shipped",
596 "api-reference/platform/shipments/cancels-the-shipment",
597 "api-reference/platform/shipments/resumes-the-shipment",
598 "api-reference/platform/shipments/moves-shipment-back-to-pending-state"
602 "group": "Shipping Categories",
604 "api-reference/platform/shipping-categories/return-a-list-of-shipping-categories",
605 "api-reference/platform/shipping-categories/create-a-shipping-category",
606 "api-reference/platform/shipping-categories/return-a-shipping-category",
607 "api-reference/platform/shipping-categories/delete-a-shipping-category",
608 "api-reference/platform/shipping-categories/update-a-shipping-category"
612 "group": "Shipping Methods",
614 "api-reference/platform/shipping-methods/return-a-list-of-shipping-methods",
615 "api-reference/platform/shipping-methods/create-a-shipping-method",
616 "api-reference/platform/shipping-methods/return-a-shipping-method",
617 "api-reference/platform/shipping-methods/delete-a-shipping-method",
618 "api-reference/platform/shipping-methods/update-a-shipping-method"
624 "api-reference/platform/states/returns-a-list-of-states",
625 "api-reference/platform/states/returns-a-state"
629 "group": "Stock Items",
631 "api-reference/platform/stock-items/return-a-list-of-stock-items",
632 "api-reference/platform/stock-items/create-a-stock-item",
633 "api-reference/platform/stock-items/return-a-stock-item",
634 "api-reference/platform/stock-items/delete-a-stock-item",
635 "api-reference/platform/stock-items/update-a-stock-item"
639 "group": "Stock Locations",
641 "api-reference/platform/stock-locations/return-a-list-of-stock-locations",
642 "api-reference/platform/stock-locations/create-a-stock-location",
643 "api-reference/platform/stock-locations/return-a-stock-location",
644 "api-reference/platform/stock-locations/delete-a-stock-location",
645 "api-reference/platform/stock-locations/update-a-stock-location"
649 "group": "Store Credit Categories",
651 "api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories",
652 "api-reference/platform/store-credit-categories/create-a-store-credit-category",
653 "api-reference/platform/store-credit-categories/return-a-store-credit-category",
654 "api-reference/platform/store-credit-categories/delete-a-store-credit-category",
655 "api-reference/platform/store-credit-categories/update-a-store-credit-category"
659 "group": "Store Credit Types",
661 "api-reference/platform/store-credit-types/return-a-list-of-store-credit-types",
662 "api-reference/platform/store-credit-types/create-a-store-credit-type",
663 "api-reference/platform/store-credit-types/return-a-store-credit-type",
664 "api-reference/platform/store-credit-types/delete-a-store-credit-type",
665 "api-reference/platform/store-credit-types/update-a-store-credit-type"
669 "group": "Store Credits",
671 "api-reference/platform/store-credits/return-a-list-of-store-credits",
672 "api-reference/platform/store-credits/create-a-store-credit",
673 "api-reference/platform/store-credits/return-a-store-credit",
674 "api-reference/platform/store-credits/delete-a-store-credit",
675 "api-reference/platform/store-credits/update-a-store-credit"
679 "group": "Tax Categories",
681 "api-reference/platform/tax-categories/return-a-list-of-tax-categories",
682 "api-reference/platform/tax-categories/create-a-tax-category",
683 "api-reference/platform/tax-categories/return-a-tax-category",
684 "api-reference/platform/tax-categories/delete-a-tax-category",
685 "api-reference/platform/tax-categories/update-a-tax-category"
689 "group": "Tax Rates",
691 "api-reference/platform/tax-rates/return-a-list-of-tax-rates",
692 "api-reference/platform/tax-rates/create-a-tax-rate",
693 "api-reference/platform/tax-rates/return-a-tax-rate",
694 "api-reference/platform/tax-rates/delete-a-tax-rate",
695 "api-reference/platform/tax-rates/update-a-tax-rate"
699 "group": "Taxonomies",
701 "api-reference/platform/taxonomies/return-a-list-of-taxonomies",
702 "api-reference/platform/taxonomies/create-a-taxonomy",
703 "api-reference/platform/taxonomies/return-a-taxonomy",
704 "api-reference/platform/taxonomies/delete-a-taxonomy",
705 "api-reference/platform/taxonomies/update-a-taxonomy"
711 "api-reference/platform/taxons/return-a-list-of-taxons",
712 "api-reference/platform/taxons/create-a-taxon",
713 "api-reference/platform/taxons/return-a-taxon",
714 "api-reference/platform/taxons/delete-a-taxon",
715 "api-reference/platform/taxons/update-a-taxon",
716 "api-reference/platform/taxons/reposition-a-taxon"
722 "api-reference/platform/users/return-a-list-of-users",
723 "api-reference/platform/users/create-a-user",
724 "api-reference/platform/users/return-a-user",
725 "api-reference/platform/users/delete-a-user",
726 "api-reference/platform/users/update-a-user"
732 "api-reference/platform/variants/return-a-list-of-variants",
733 "api-reference/platform/variants/return-a-variant",
734 "api-reference/platform/variants/delete-a-variant"
738 "group": "Webhook Events",
740 "api-reference/platform/webhook-events/return-a-list-of-webhook-events"
744 "group": "Webhook Subscribers",
746 "api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers",
747 "api-reference/platform/webhook-subscribers/create-a-webhook-subscriber",
748 "api-reference/platform/webhook-subscribers/return-a-webhook-subscriber",
749 "api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber",
750 "api-reference/platform/webhook-subscribers/update-a-webhook-subscriber"
754 "group": "Wished Items",
756 "api-reference/platform/wished-items/return-a-list-of-wished-items",
757 "api-reference/platform/wished-items/create-a-wished-item",
758 "api-reference/platform/wished-items/return-a-wished-item",
759 "api-reference/platform/wished-items/delete-a-wished-item",
760 "api-reference/platform/wished-items/update-a-wished-item"
764 "group": "Wishlists",
766 "api-reference/platform/wishlists/return-a-list-of-wishlists",
767 "api-reference/platform/wishlists/create-a-wishlist",
768 "api-reference/platform/wishlists/return-a-wishlist",
769 "api-reference/platform/wishlists/delete-a-wishlist",
770 "api-reference/platform/wishlists/update-a-wishlist"
776 "api-reference/platform/zones/return-a-list-of-zones",
777 "api-reference/platform/zones/create-a-zone",
778 "api-reference/platform/zones/return-a-zone",
779 "api-reference/platform/zones/delete-a-zone",
780 "api-reference/platform/zones/update-a-zone"
787 "github": "https://github.com/spree/spree",
788 "x": "https://x.com/spreecommerce"
791 "thumbsRating": true,
797 "measurementId": "G-NCVLCVHL5Y"