# Spree Commerce documentation ## Docs - [Create an Address](https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address.md): Creates an Address - [Delete an Address](https://spreecommerce.org/docs/api-reference/platform/addresses/delete-an-address.md): Deletes an Address - [Return a list of Addresses](https://spreecommerce.org/docs/api-reference/platform/addresses/return-a-list-of-addresses.md): Returns a list of Addresses - [Return an Address](https://spreecommerce.org/docs/api-reference/platform/addresses/return-an-address.md): Returns an Address - [Update an Address](https://spreecommerce.org/docs/api-reference/platform/addresses/update-an-address.md): Updates an Address - [Create an Adjustment](https://spreecommerce.org/docs/api-reference/platform/adjustments/create-an-adjustment.md): Creates an Adjustment - [Delete an Adjustment](https://spreecommerce.org/docs/api-reference/platform/adjustments/delete-an-adjustment.md): Deletes an Adjustment - [Return a list of Adjustments](https://spreecommerce.org/docs/api-reference/platform/adjustments/return-a-list-of-adjustments.md): Returns a list of Adjustments - [Return an Adjustment](https://spreecommerce.org/docs/api-reference/platform/adjustments/return-an-adjustment.md): Returns an Adjustment - [Update an Adjustment](https://spreecommerce.org/docs/api-reference/platform/adjustments/update-an-adjustment.md): Updates an Adjustment - [Authentication](https://spreecommerce.org/docs/api-reference/platform/authentication.md) - [Create a Classification](https://spreecommerce.org/docs/api-reference/platform/classifications/create-a-classification.md): Creates a Classification - [Delete a Classification](https://spreecommerce.org/docs/api-reference/platform/classifications/delete-a-classification.md): Deletes a Classification - [Return a Classification](https://spreecommerce.org/docs/api-reference/platform/classifications/return-a-classification.md): Returns a Classification - [Return a list of Classifications](https://spreecommerce.org/docs/api-reference/platform/classifications/return-a-list-of-classifications.md): Returns a list of Classifications - [Update a Classification](https://spreecommerce.org/docs/api-reference/platform/classifications/update-a-classification.md): Updates a Classification - [Create a CMS Page](https://spreecommerce.org/docs/api-reference/platform/cms-pages/create-a-cms-page.md): Creates a CMS Page - [Delete a CMS Page](https://spreecommerce.org/docs/api-reference/platform/cms-pages/delete-a-cms-page.md): Deletes a CMS Page - [Return a CMS Page](https://spreecommerce.org/docs/api-reference/platform/cms-pages/return-a-cms-page.md): Returns a CMS Page - [Return a list of CMS Pages](https://spreecommerce.org/docs/api-reference/platform/cms-pages/return-a-list-of-cms-pages.md): Returns a list of CMS Pages - [Update a CMS Page](https://spreecommerce.org/docs/api-reference/platform/cms-pages/update-a-cms-page.md): Updates a CMS Page - [Create a CMS Section](https://spreecommerce.org/docs/api-reference/platform/cms-sections/create-a-cms-section.md): Creates a CMS Section - [Delete a CMS Section](https://spreecommerce.org/docs/api-reference/platform/cms-sections/delete-a-cms-section.md): Deletes a CMS Section - [Return a CMS Section](https://spreecommerce.org/docs/api-reference/platform/cms-sections/return-a-cms-section.md): Returns a CMS Section - [Return a list of CMS Sections](https://spreecommerce.org/docs/api-reference/platform/cms-sections/return-a-list-of-cms-sections.md): Returns a list of CMS Sections - [Update a CMS Section](https://spreecommerce.org/docs/api-reference/platform/cms-sections/update-a-cms-section.md): Updates a CMS Section - [Returns a Country](https://spreecommerce.org/docs/api-reference/platform/countries/returns-a-country.md): Returns a Country - [Returns a list of Countries](https://spreecommerce.org/docs/api-reference/platform/countries/returns-a-list-of-countries.md): Returns a list of Countries - [Create a Data Feed](https://spreecommerce.org/docs/api-reference/platform/data-feeds/create-a-data-feed.md): Creates a Data Feed - [Delete a Data Feed](https://spreecommerce.org/docs/api-reference/platform/data-feeds/delete-a-data-feed.md): Deletes a Data Feed - [Return a Data Feed](https://spreecommerce.org/docs/api-reference/platform/data-feeds/return-a-data-feed.md): Returns a Data Feed - [Return a list of Data Feeds](https://spreecommerce.org/docs/api-reference/platform/data-feeds/return-a-list-of-data-feeds.md) - [Update a Data Feed](https://spreecommerce.org/docs/api-reference/platform/data-feeds/update-a-data-feed.md): Updates a Data Feed - [Create a Digital Asset](https://spreecommerce.org/docs/api-reference/platform/digital-assets/create-a-digital-asset.md): Creates a Digital Asset - [Delete a Digital Asset](https://spreecommerce.org/docs/api-reference/platform/digital-assets/delete-a-digital-asset.md): Deletes a Digital Asset - [Return a Digital Asset](https://spreecommerce.org/docs/api-reference/platform/digital-assets/return-a-digital-asset.md): Returns a Digital Asset - [Return a list of Digital Assets](https://spreecommerce.org/docs/api-reference/platform/digital-assets/return-a-list-of-digital-assets.md): Returns a list of Digital Assets - [Update a Digital Asset](https://spreecommerce.org/docs/api-reference/platform/digital-assets/update-a-digital-asset.md): Updates a Digital Asset - [Create a Digital Link](https://spreecommerce.org/docs/api-reference/platform/digital-links/create-a-digital-link.md): Creates a Digital Link - [Delete a Digital Link](https://spreecommerce.org/docs/api-reference/platform/digital-links/delete-a-digital-link.md): Deletes a Digital Link - [Reset a Digital Link](https://spreecommerce.org/docs/api-reference/platform/digital-links/reset-a-digital-link.md): Resets a digital link, allowing further downloads. - [Return a Digital Link](https://spreecommerce.org/docs/api-reference/platform/digital-links/return-a-digital-link.md): Returns a Digital Link - [Return a list of Digital Links](https://spreecommerce.org/docs/api-reference/platform/digital-links/return-a-list-of-digital-links.md): Returns a list of Digital Links - [Update a Digital Link](https://spreecommerce.org/docs/api-reference/platform/digital-links/update-a-digital-link.md): Updates a Digital Link - [Create a Line Item](https://spreecommerce.org/docs/api-reference/platform/line-items/create-a-line-item.md): Creates a Line Item - [Delete a Line Item](https://spreecommerce.org/docs/api-reference/platform/line-items/delete-a-line-item.md): Deletes a Line Item - [Return a Line Item](https://spreecommerce.org/docs/api-reference/platform/line-items/return-a-line-item.md): Returns a Line Item - [Return a list of Line Items](https://spreecommerce.org/docs/api-reference/platform/line-items/return-a-list-of-line-items.md): Returns a list of Line Items - [Update a Line Item](https://spreecommerce.org/docs/api-reference/platform/line-items/update-a-line-item.md): Updates a Line Item - [Create a Menu Item](https://spreecommerce.org/docs/api-reference/platform/menu-items/create-a-menu-item.md): Creates a Menu Item - [Delete a Menu Item](https://spreecommerce.org/docs/api-reference/platform/menu-items/delete-a-menu-item.md): Deletes a Menu Item - [Reposition a Menu Item](https://spreecommerce.org/docs/api-reference/platform/menu-items/reposition-a-menu-item.md): Reposition a Menu Item - [Return a list of Menu Items](https://spreecommerce.org/docs/api-reference/platform/menu-items/return-a-list-of-menu-items.md): Returns a list of Menu Items - [Return a Menu Item](https://spreecommerce.org/docs/api-reference/platform/menu-items/return-a-menu-item.md): Returns a Menu Item - [Update a Menu Item](https://spreecommerce.org/docs/api-reference/platform/menu-items/update-a-menu-item.md): Updates a Menu Item - [Create a Menu](https://spreecommerce.org/docs/api-reference/platform/menus/create-a-menu.md): Creates a Menu - [Delete a Menu](https://spreecommerce.org/docs/api-reference/platform/menus/delete-a-menu.md): Deletes a Menu - [Return a list of Menus](https://spreecommerce.org/docs/api-reference/platform/menus/return-a-list-of-menus.md): Returns a list of Menus - [Return a Menu](https://spreecommerce.org/docs/api-reference/platform/menus/return-a-menu.md): Returns a Menu - [Update a Menu](https://spreecommerce.org/docs/api-reference/platform/menus/update-a-menu.md): Updates a Menu - [Create an Option Type](https://spreecommerce.org/docs/api-reference/platform/option-types/create-an-option-type.md): Creates an Option Type - [Delete an Option Type](https://spreecommerce.org/docs/api-reference/platform/option-types/delete-an-option-type.md): Deletes an Option Type - [Return a list of Option Types](https://spreecommerce.org/docs/api-reference/platform/option-types/return-a-list-of-option-types.md): Returns a list of Option Types - [Return an Option Type](https://spreecommerce.org/docs/api-reference/platform/option-types/return-an-option-type.md): Returns an Option Type - [Update an Option Type](https://spreecommerce.org/docs/api-reference/platform/option-types/update-an-option-type.md): Updates an Option Type - [Create an Option Value](https://spreecommerce.org/docs/api-reference/platform/option-values/create-an-option-value.md): Creates an Option Value - [Delete an Option Value](https://spreecommerce.org/docs/api-reference/platform/option-values/delete-an-option-value.md): Deletes an Option Value - [Return a list of Option Values](https://spreecommerce.org/docs/api-reference/platform/option-values/return-a-list-of-option-values.md): Returns a list of Option Values - [Return an Option Value](https://spreecommerce.org/docs/api-reference/platform/option-values/return-an-option-value.md): Returns an Option Value - [Update an Option Value](https://spreecommerce.org/docs/api-reference/platform/option-values/update-an-option-value.md): Updates an Option Value - [Advances an Order](https://spreecommerce.org/docs/api-reference/platform/orders/advances-an-order.md): Advances an Order - [Apply Coupon Code for an Order](https://spreecommerce.org/docs/api-reference/platform/orders/apply-coupon-code-for-an-order.md): Creates Store Credit payment for an Order - [Approves an Order](https://spreecommerce.org/docs/api-reference/platform/orders/approves-an-order.md): Approves an Order, when using a token created for a user, it will save this user as the approver - [Cancels an Order](https://spreecommerce.org/docs/api-reference/platform/orders/cancels-an-order.md): Cancels an Order, when using a token created for a user, it will save this user as the canceler - [Completes an Order](https://spreecommerce.org/docs/api-reference/platform/orders/completes-an-order.md): Marks an Order as completed - [Creates an Order](https://spreecommerce.org/docs/api-reference/platform/orders/creates-an-order.md): Creates an Order - [Delete an Order](https://spreecommerce.org/docs/api-reference/platform/orders/delete-an-order.md): Deletes an Order - [Empties an Order](https://spreecommerce.org/docs/api-reference/platform/orders/empties-an-order.md): Removes all line items, promotions, shipment and payments from an Order - [Next an Order](https://spreecommerce.org/docs/api-reference/platform/orders/next-an-order.md): Moves an Order to the next state - [Return a list of Orders](https://spreecommerce.org/docs/api-reference/platform/orders/return-a-list-of-orders.md): Returns a list of Orders - [Return an Order](https://spreecommerce.org/docs/api-reference/platform/orders/return-an-order.md): Returns an Order - [Update an Order](https://spreecommerce.org/docs/api-reference/platform/orders/update-an-order.md): Updates an Order - [Use Store Credit for an Order](https://spreecommerce.org/docs/api-reference/platform/orders/use-store-credit-for-an-order.md): Creates Store Credit payment for an Order - [Create a Payment Method](https://spreecommerce.org/docs/api-reference/platform/payment-methods/create-a-payment-method.md): Creates a Payment Method - [Delete a Payment Method](https://spreecommerce.org/docs/api-reference/platform/payment-methods/delete-a-payment-method.md): Deletes a Payment Method - [Return a list of Payment Methods](https://spreecommerce.org/docs/api-reference/platform/payment-methods/return-a-list-of-payment-methods.md): Returns a list of Payment Methods - [Return a Payment Method](https://spreecommerce.org/docs/api-reference/platform/payment-methods/return-a-payment-method.md): Returns a Payment Method - [Update a Payment Method](https://spreecommerce.org/docs/api-reference/platform/payment-methods/update-a-payment-method.md): Updates a Payment Method - [Delete a Payment](https://spreecommerce.org/docs/api-reference/platform/payments/delete-a-payment.md): Deletes a Payment - [Return a list of Payments](https://spreecommerce.org/docs/api-reference/platform/payments/return-a-list-of-payments.md): Returns a list of Payments - [Return a Payment](https://spreecommerce.org/docs/api-reference/platform/payments/return-a-payment.md): Returns a Payment - [Create a Product](https://spreecommerce.org/docs/api-reference/platform/products/create-a-product.md): Creates a Product - [Delete a Product](https://spreecommerce.org/docs/api-reference/platform/products/delete-a-product.md): Deletes a Product - [Return a list of Products](https://spreecommerce.org/docs/api-reference/platform/products/return-a-list-of-products.md): Returns a list of Products - [Return a Product](https://spreecommerce.org/docs/api-reference/platform/products/return-a-product.md): Returns a Product - [Update a Product](https://spreecommerce.org/docs/api-reference/platform/products/update-a-product.md): Updates a Product - [Create a Promotion Action](https://spreecommerce.org/docs/api-reference/platform/promotion-actions/create-a-promotion-action.md): Creates a Promotion Action - [Delete a Promotion Action](https://spreecommerce.org/docs/api-reference/platform/promotion-actions/delete-a-promotion-action.md): Deletes a Promotion Action - [Return a list of Promotion Actions](https://spreecommerce.org/docs/api-reference/platform/promotion-actions/return-a-list-of-promotion-actions.md): Returns a list of Promotion Actions - [Return a Promotion Action](https://spreecommerce.org/docs/api-reference/platform/promotion-actions/return-a-promotion-action.md): Returns a Promotion Action - [Update a Promotion Action](https://spreecommerce.org/docs/api-reference/platform/promotion-actions/update-a-promotion-action.md): Updates a Promotion Action - [Create a Promotion Category](https://spreecommerce.org/docs/api-reference/platform/promotion-categories/create-a-promotion-category.md): Creates a Promotion Category - [Delete a Promotion Category](https://spreecommerce.org/docs/api-reference/platform/promotion-categories/delete-a-promotion-category.md): Deletes a Promotion Category - [Return a list of Promotion Categories](https://spreecommerce.org/docs/api-reference/platform/promotion-categories/return-a-list-of-promotion-categories.md): Returns a list of Promotion Categories - [Return a Promotion Category](https://spreecommerce.org/docs/api-reference/platform/promotion-categories/return-a-promotion-category.md): Returns a Promotion Category - [Update a Promotion Category](https://spreecommerce.org/docs/api-reference/platform/promotion-categories/update-a-promotion-category.md): Updates a Promotion Category - [Create a Promotion Rule](https://spreecommerce.org/docs/api-reference/platform/promotion-rules/create-a-promotion-rule.md): Creates a Promotion Rule - [Delete a Promotion Rule](https://spreecommerce.org/docs/api-reference/platform/promotion-rules/delete-a-promotion-rule.md): Deletes a Promotion Rule - [Return a list of Promotion Rules](https://spreecommerce.org/docs/api-reference/platform/promotion-rules/return-a-list-of-promotion-rules.md): Returns a list of Promotion Rules - [Return a Promotion Rule](https://spreecommerce.org/docs/api-reference/platform/promotion-rules/return-a-promotion-rule.md): Returns a Promotion Rule - [Update a Promotion Rule](https://spreecommerce.org/docs/api-reference/platform/promotion-rules/update-a-promotion-rule.md): Updates a Promotion Rule - [Create a Promotion](https://spreecommerce.org/docs/api-reference/platform/promotions/create-a-promotion.md): Creates a Promotion - [Delete a Promotion](https://spreecommerce.org/docs/api-reference/platform/promotions/delete-a-promotion.md): Deletes a Promotion - [Return a list of Promotions](https://spreecommerce.org/docs/api-reference/platform/promotions/return-a-list-of-promotions.md): Returns a list of Promotions - [Return a Promotion](https://spreecommerce.org/docs/api-reference/platform/promotions/return-a-promotion.md): Returns a Promotion - [Update a Promotion](https://spreecommerce.org/docs/api-reference/platform/promotions/update-a-promotion.md): Updates a Promotion - [Create a Role](https://spreecommerce.org/docs/api-reference/platform/roles/create-a-role.md): Creates a Role - [Delete a Role](https://spreecommerce.org/docs/api-reference/platform/roles/delete-a-role.md): Deletes a Role - [Return a list of Roles](https://spreecommerce.org/docs/api-reference/platform/roles/return-a-list-of-roles.md): Returns a list of Roles - [Return a Role](https://spreecommerce.org/docs/api-reference/platform/roles/return-a-role.md): Returns a Role - [Update a Role](https://spreecommerce.org/docs/api-reference/platform/roles/update-a-role.md): Updates a Role - [Adds item (Variant) to an existing Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment.md): If selected Variant was already added to Order it will increase the quantity of existing Line Item, if not it will create a new Line Item - [Cancels the Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/cancels-the-shipment.md): Cancels the Shipment - [Create a Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/create-a-shipment.md): Creates a Shipment - [Delete a Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/delete-a-shipment.md): Deletes a Shipment - [Mark Shipment as ready to be shipped](https://spreecommerce.org/docs/api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped.md): Marks Shipment as ready to be shipped - [Mark Shipment as shipped](https://spreecommerce.org/docs/api-reference/platform/shipments/mark-shipment-as-shipped.md): Marks Shipment as shipped - [Moves Shipment back to pending state](https://spreecommerce.org/docs/api-reference/platform/shipments/moves-shipment-back-to-pending-state.md): Moves Shipment back to pending state - [Removes item (Variant) from Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/removes-item-variant-from-shipment.md): If selected Variant is removed completely and Shipment doesn't include any other Line Items, Shipment itself will be deleted - [Resumes the Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/resumes-the-shipment.md): Resumes previously canceled Shipment - [Return a list of Shipments](https://spreecommerce.org/docs/api-reference/platform/shipments/return-a-list-of-shipments.md): Returns a list of Shipments - [Return a Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/return-a-shipment.md): Returns a Shipment - [Update a Shipment](https://spreecommerce.org/docs/api-reference/platform/shipments/update-a-shipment.md): Updates a Shipment - [Create a Shipping Category](https://spreecommerce.org/docs/api-reference/platform/shipping-categories/create-a-shipping-category.md): Creates a Shipping Category - [Delete a Shipping Category](https://spreecommerce.org/docs/api-reference/platform/shipping-categories/delete-a-shipping-category.md): Deletes a Shipping Category - [Return a list of Shipping Categories](https://spreecommerce.org/docs/api-reference/platform/shipping-categories/return-a-list-of-shipping-categories.md): Returns a list of Shipping Categories - [Return a Shipping Category](https://spreecommerce.org/docs/api-reference/platform/shipping-categories/return-a-shipping-category.md): Returns a Shipping Category - [Update a Shipping Category](https://spreecommerce.org/docs/api-reference/platform/shipping-categories/update-a-shipping-category.md): Updates a Shipping Category - [Create a Shipping Method](https://spreecommerce.org/docs/api-reference/platform/shipping-methods/create-a-shipping-method.md): Creates a Shipping Method - [Delete a Shipping Method](https://spreecommerce.org/docs/api-reference/platform/shipping-methods/delete-a-shipping-method.md): Deletes a Shipping Method - [Return a list of Shipping Methods](https://spreecommerce.org/docs/api-reference/platform/shipping-methods/return-a-list-of-shipping-methods.md): Returns a list of Shipping Methods - [Return a Shipping Method](https://spreecommerce.org/docs/api-reference/platform/shipping-methods/return-a-shipping-method.md): Returns a Shipping Method - [Update a Shipping Method](https://spreecommerce.org/docs/api-reference/platform/shipping-methods/update-a-shipping-method.md): Updates a Shipping Method - [Returns a list of States](https://spreecommerce.org/docs/api-reference/platform/states/returns-a-list-of-states.md): Returns a list of States - [Returns a State](https://spreecommerce.org/docs/api-reference/platform/states/returns-a-state.md): Returns a State - [Create a Stock Item](https://spreecommerce.org/docs/api-reference/platform/stock-items/create-a-stock-item.md): Creates a Stock Item - [Delete a Stock Item](https://spreecommerce.org/docs/api-reference/platform/stock-items/delete-a-stock-item.md): Deletes a Stock Item - [Return a list of Stock Items](https://spreecommerce.org/docs/api-reference/platform/stock-items/return-a-list-of-stock-items.md): Returns a list of Stock Items - [Return a Stock Item](https://spreecommerce.org/docs/api-reference/platform/stock-items/return-a-stock-item.md): Returns a Stock Item - [Update a Stock Item](https://spreecommerce.org/docs/api-reference/platform/stock-items/update-a-stock-item.md): Updates a Stock Item - [Create a Stock Location](https://spreecommerce.org/docs/api-reference/platform/stock-locations/create-a-stock-location.md): Creates a Stock Location - [Delete a Stock Location](https://spreecommerce.org/docs/api-reference/platform/stock-locations/delete-a-stock-location.md): Deletes a Stock Location - [Return a list of Stock Locations](https://spreecommerce.org/docs/api-reference/platform/stock-locations/return-a-list-of-stock-locations.md): Returns a list of Stock Locations - [Return a Stock Location](https://spreecommerce.org/docs/api-reference/platform/stock-locations/return-a-stock-location.md): Returns a Stock Location - [Update a Stock Location](https://spreecommerce.org/docs/api-reference/platform/stock-locations/update-a-stock-location.md): Updates a Stock Location - [Create a Store Credit Category](https://spreecommerce.org/docs/api-reference/platform/store-credit-categories/create-a-store-credit-category.md): Creates a Store Credit Category - [Delete a Store Credit Category](https://spreecommerce.org/docs/api-reference/platform/store-credit-categories/delete-a-store-credit-category.md): Deletes a Store Credit Category - [Return a list of Store Credit Categories](https://spreecommerce.org/docs/api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories.md): Returns a list of Store Credit Categories - [Return a Store Credit Category](https://spreecommerce.org/docs/api-reference/platform/store-credit-categories/return-a-store-credit-category.md): Returns a Store Credit Category - [Update a Store Credit Category](https://spreecommerce.org/docs/api-reference/platform/store-credit-categories/update-a-store-credit-category.md): Updates a Store Credit Category - [Create a Store Credit Type](https://spreecommerce.org/docs/api-reference/platform/store-credit-types/create-a-store-credit-type.md): Creates a Store Credit Type - [Delete a Store Credit Type](https://spreecommerce.org/docs/api-reference/platform/store-credit-types/delete-a-store-credit-type.md): Deletes a Store Credit Type - [Return a list of Store Credit Types](https://spreecommerce.org/docs/api-reference/platform/store-credit-types/return-a-list-of-store-credit-types.md): Returns a list of Store Credit Types - [Return a Store Credit Type](https://spreecommerce.org/docs/api-reference/platform/store-credit-types/return-a-store-credit-type.md): Returns a Store Credit Type - [Update a Store Credit Type](https://spreecommerce.org/docs/api-reference/platform/store-credit-types/update-a-store-credit-type.md): Updates a Store Credit Type - [Create a Store Credit](https://spreecommerce.org/docs/api-reference/platform/store-credits/create-a-store-credit.md): Creates a Store Credit - [Delete a Store Credit](https://spreecommerce.org/docs/api-reference/platform/store-credits/delete-a-store-credit.md): Deletes a Store Credit - [Return a list of Store Credits](https://spreecommerce.org/docs/api-reference/platform/store-credits/return-a-list-of-store-credits.md): Returns a list of Store Credits - [Return a Store Credit](https://spreecommerce.org/docs/api-reference/platform/store-credits/return-a-store-credit.md): Returns a Store Credit - [Update a Store Credit](https://spreecommerce.org/docs/api-reference/platform/store-credits/update-a-store-credit.md): Updates a Store Credit - [Create a Tax Category](https://spreecommerce.org/docs/api-reference/platform/tax-categories/create-a-tax-category.md): Creates a Tax Category - [Delete a Tax Category](https://spreecommerce.org/docs/api-reference/platform/tax-categories/delete-a-tax-category.md): Deletes a Tax Category - [Return a list of Tax Categories](https://spreecommerce.org/docs/api-reference/platform/tax-categories/return-a-list-of-tax-categories.md): Returns a list of Tax Categories - [Return a Tax Category](https://spreecommerce.org/docs/api-reference/platform/tax-categories/return-a-tax-category.md): Returns a Tax Category - [Update a Tax Category](https://spreecommerce.org/docs/api-reference/platform/tax-categories/update-a-tax-category.md): Updates a Tax Category - [Create a Tax Rate](https://spreecommerce.org/docs/api-reference/platform/tax-rates/create-a-tax-rate.md): Creates a Tax Rate - [Delete a Tax Rate](https://spreecommerce.org/docs/api-reference/platform/tax-rates/delete-a-tax-rate.md): Deletes a Tax Rate - [Return a list of Tax Rates](https://spreecommerce.org/docs/api-reference/platform/tax-rates/return-a-list-of-tax-rates.md): Returns a list of Tax Rates - [Return a Tax Rate](https://spreecommerce.org/docs/api-reference/platform/tax-rates/return-a-tax-rate.md): Returns a Tax Rate - [Update a Tax Rate](https://spreecommerce.org/docs/api-reference/platform/tax-rates/update-a-tax-rate.md): Updates a Tax Rate - [Create a Taxonomy](https://spreecommerce.org/docs/api-reference/platform/taxonomies/create-a-taxonomy.md): Creates a Taxonomy - [Delete a Taxonomy](https://spreecommerce.org/docs/api-reference/platform/taxonomies/delete-a-taxonomy.md): Deletes a Taxonomy - [Return a list of Taxonomies](https://spreecommerce.org/docs/api-reference/platform/taxonomies/return-a-list-of-taxonomies.md): Returns a list of Taxonomies - [Return a Taxonomy](https://spreecommerce.org/docs/api-reference/platform/taxonomies/return-a-taxonomy.md): Returns a Taxonomy - [Update a Taxonomy](https://spreecommerce.org/docs/api-reference/platform/taxonomies/update-a-taxonomy.md): Updates a Taxonomy - [Create a Taxon](https://spreecommerce.org/docs/api-reference/platform/taxons/create-a-taxon.md): Creates a Taxon - [Delete a Taxon](https://spreecommerce.org/docs/api-reference/platform/taxons/delete-a-taxon.md): Deletes a Taxon - [Reposition a Taxon](https://spreecommerce.org/docs/api-reference/platform/taxons/reposition-a-taxon.md): Reposition a Taxon - [Return a list of Taxons](https://spreecommerce.org/docs/api-reference/platform/taxons/return-a-list-of-taxons.md): Returns a list of Taxons - [Return a Taxon](https://spreecommerce.org/docs/api-reference/platform/taxons/return-a-taxon.md): Returns a Taxon - [Update a Taxon](https://spreecommerce.org/docs/api-reference/platform/taxons/update-a-taxon.md): Updates a Taxon - [Create a User](https://spreecommerce.org/docs/api-reference/platform/users/create-a-user.md): Creates a User - [Delete a User](https://spreecommerce.org/docs/api-reference/platform/users/delete-a-user.md): Deletes a User - [Return a list of Users](https://spreecommerce.org/docs/api-reference/platform/users/return-a-list-of-users.md): Returns a list of Users - [Return a User](https://spreecommerce.org/docs/api-reference/platform/users/return-a-user.md): Returns a User - [Update a User](https://spreecommerce.org/docs/api-reference/platform/users/update-a-user.md): Updates a User - [Delete a Variant](https://spreecommerce.org/docs/api-reference/platform/variants/delete-a-variant.md): Deletes a Variant - [Return a list of Variants](https://spreecommerce.org/docs/api-reference/platform/variants/return-a-list-of-variants.md): Returns a list of Variants - [Return a Variant](https://spreecommerce.org/docs/api-reference/platform/variants/return-a-variant.md): Returns a Variant - [Approves Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/approves-vendor.md): Marks Vendor as approved, and triggers an approval email send out to the vendor's contact person. Also activated Vendor products will become available for purchase. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Completes onboarding process](https://spreecommerce.org/docs/api-reference/platform/vendors/completes-onboarding-process.md): Marks Vendor as onboarding complete. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Create a Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/create-a-vendor.md): Creates a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Delete a Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/delete-a-vendor.md): Deletes a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Invites Vendor to the platform](https://spreecommerce.org/docs/api-reference/platform/vendors/invites-vendor-to-the-platform.md): Also triggers an invitation email send out to the vendor's contact person. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Rejects Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/rejects-vendor.md): Marks Vendor as rejected, and triggers an approval email send out to the vendor's contact person. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Return a list of Vendors](https://spreecommerce.org/docs/api-reference/platform/vendors/return-a-list-of-vendors.md): Returns a list of Vendors. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Return a Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/return-a-vendor.md): Returns a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Start onboarding process](https://spreecommerce.org/docs/api-reference/platform/vendors/start-onboarding-process.md): Marks Vendor as onboarding in progress. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Suspends Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/suspends-vendor.md): Marks Vendor as suspended, and triggers an approval email send out to the vendor's contact person. Also the vendor's products will become unavailable for purchase and will be hidden from the storefront. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Update a Vendor](https://spreecommerce.org/docs/api-reference/platform/vendors/update-a-vendor.md): Updates a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Return a list of Webhook Events](https://spreecommerce.org/docs/api-reference/platform/webhook-events/return-a-list-of-webhook-events.md): Returns a list of Webhook Events - [Create a Webhook Subscriber](https://spreecommerce.org/docs/api-reference/platform/webhook-subscribers/create-a-webhook-subscriber.md): Creates a Webhook Subscriber - [Delete a Webhook Subscriber](https://spreecommerce.org/docs/api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber.md): Deletes a Webhook Subscriber - [Return a list of Webhook Subscribers](https://spreecommerce.org/docs/api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers.md): Returns a list of Webhook Subscribers - [Return a Webhook Subscriber](https://spreecommerce.org/docs/api-reference/platform/webhook-subscribers/return-a-webhook-subscriber.md): Returns a Webhook Subscriber - [Update a Webhook Subscriber](https://spreecommerce.org/docs/api-reference/platform/webhook-subscribers/update-a-webhook-subscriber.md): Updates a Webhook Subscriber - [Create a Wished Item](https://spreecommerce.org/docs/api-reference/platform/wished-items/create-a-wished-item.md): Creates a Wished Item - [Delete a Wished Item](https://spreecommerce.org/docs/api-reference/platform/wished-items/delete-a-wished-item.md): Deletes a Wished Item - [Return a list of Wished Items](https://spreecommerce.org/docs/api-reference/platform/wished-items/return-a-list-of-wished-items.md): Returns a list of Wished Items - [Return a Wished Item](https://spreecommerce.org/docs/api-reference/platform/wished-items/return-a-wished-item.md): Returns a Wished Item - [Update a Wished Item](https://spreecommerce.org/docs/api-reference/platform/wished-items/update-a-wished-item.md): Updates a Wished Item - [Create a Wishlist](https://spreecommerce.org/docs/api-reference/platform/wishlists/create-a-wishlist.md): Creates a Wishlist - [Delete a Wishlist](https://spreecommerce.org/docs/api-reference/platform/wishlists/delete-a-wishlist.md): Deletes a Wishlist - [Return a list of Wishlists](https://spreecommerce.org/docs/api-reference/platform/wishlists/return-a-list-of-wishlists.md): Returns a list of Wishlists - [Return a Wishlist](https://spreecommerce.org/docs/api-reference/platform/wishlists/return-a-wishlist.md): Returns a Wishlist - [Update a Wishlist](https://spreecommerce.org/docs/api-reference/platform/wishlists/update-a-wishlist.md): Updates a Wishlist - [Create a Zone](https://spreecommerce.org/docs/api-reference/platform/zones/create-a-zone.md): Creates a Zone - [Delete a Zone](https://spreecommerce.org/docs/api-reference/platform/zones/delete-a-zone.md): Deletes a Zone - [Return a list of Zones](https://spreecommerce.org/docs/api-reference/platform/zones/return-a-list-of-zones.md): Returns a list of Zones - [Return a Zone](https://spreecommerce.org/docs/api-reference/platform/zones/return-a-zone.md): Returns a Zone - [Update a Zone](https://spreecommerce.org/docs/api-reference/platform/zones/update-a-zone.md): Updates a Zone - [Authentication](https://spreecommerce.org/docs/api-reference/store-api/authentication.md): How to authenticate requests to the Store API - [Login](https://spreecommerce.org/docs/api-reference/store-api/authentication/login.md): Authenticates a customer with email/password and returns a JWT token - [Logout](https://spreecommerce.org/docs/api-reference/store-api/authentication/logout.md): Revokes the refresh token, effectively logging the customer out. - [Refresh token](https://spreecommerce.org/docs/api-reference/store-api/authentication/refresh-token.md): Exchanges a refresh token for a new access JWT and rotated refresh token. No Authorization header needed. - [Request a password reset](https://spreecommerce.org/docs/api-reference/store-api/authentication/request-a-password-reset.md): Sends a password reset email if an account exists for the given email address. Always returns 202 Accepted to prevent email enumeration. - [Reset password with token](https://spreecommerce.org/docs/api-reference/store-api/authentication/reset-password-with-token.md): Resets the password using a token received via email. Returns a JWT token on success (auto-login). - [Add item to cart](https://spreecommerce.org/docs/api-reference/store-api/carts/add-item-to-cart.md): Adds a variant to the cart. Creates a new line item or increases quantity if variant already in cart. - [Apply discount code](https://spreecommerce.org/docs/api-reference/store-api/carts/apply-discount-code.md): Applies a promotion discount code to the cart. The code is matched case-insensitively. - [Apply gift card](https://spreecommerce.org/docs/api-reference/store-api/carts/apply-gift-card.md): Applies a gift card to the cart. Gift cards are treated as a payment method, not a discount — the cart `total` remains unchanged while `amount_due` is reduced. - [Apply store credit](https://spreecommerce.org/docs/api-reference/store-api/carts/apply-store-credit.md): Applies store credit to the cart during checkout. - [Associate guest cart with authenticated user](https://spreecommerce.org/docs/api-reference/store-api/carts/associate-guest-cart-with-authenticated-user.md): Associates a guest cart with the currently authenticated user. Requires JWT authentication. The cart must not belong to another user. - [Complete cart](https://spreecommerce.org/docs/api-reference/store-api/carts/complete-cart.md): Completes the cart and finalizes the purchase. Returns an Order (not Cart). - [Complete payment session](https://spreecommerce.org/docs/api-reference/store-api/carts/complete-payment-session.md): Completes a payment session by confirming the payment with the provider. This triggers payment capture/authorization and order completion. - [Create a new cart](https://spreecommerce.org/docs/api-reference/store-api/carts/create-a-new-cart.md): Creates a new shopping cart. Can be created by guests or authenticated customers. Returns a `token` that must be used for guest access to the cart. - [Create payment](https://spreecommerce.org/docs/api-reference/store-api/carts/create-payment.md): Creates a payment for a non-session payment method (e.g. Check, Cash on Delivery, Bank Transfer). For payment methods that require a session (e.g. Stripe, PayPal), use the payment sessions endpoint instead. - [Create payment session](https://spreecommerce.org/docs/api-reference/store-api/carts/create-payment-session.md): Creates a new payment session for the cart. Delegates to the payment gateway to initialize a provider-specific session (e.g. Stripe PaymentIntent, Adyen session, PayPal order). - [Delete a cart](https://spreecommerce.org/docs/api-reference/store-api/carts/delete-a-cart.md): Deletes/abandons the cart. - [Get a cart](https://spreecommerce.org/docs/api-reference/store-api/carts/get-a-cart.md): Returns a shopping cart by prefixed ID. Authorize via x-spree-token header (guest) or JWT Bearer token (authenticated user). - [Get payment session](https://spreecommerce.org/docs/api-reference/store-api/carts/get-payment-session.md): Returns a single payment session with its current status and provider data. - [List active carts](https://spreecommerce.org/docs/api-reference/store-api/carts/list-active-carts.md): Returns all active (incomplete) carts for the authenticated user. - [Remove discount code](https://spreecommerce.org/docs/api-reference/store-api/carts/remove-discount-code.md): Removes a previously applied discount code from the cart. The ID is the discount code string itself. - [Remove gift card](https://spreecommerce.org/docs/api-reference/store-api/carts/remove-gift-card.md): Removes a previously applied gift card from the cart. - [Remove line item from cart](https://spreecommerce.org/docs/api-reference/store-api/carts/remove-line-item-from-cart.md): Removes a line item from the cart - [Remove store credit](https://spreecommerce.org/docs/api-reference/store-api/carts/remove-store-credit.md): Removes store credit from the cart. - [Select delivery rate for fulfillment](https://spreecommerce.org/docs/api-reference/store-api/carts/select-delivery-rate-for-fulfillment.md): Selects a delivery rate for a specific fulfillment and auto-advances checkout. - [Update a cart](https://spreecommerce.org/docs/api-reference/store-api/carts/update-a-cart.md): Updates cart info (email, addresses, customer note). When addresses change, the order state is reverted to address to ensure shipments are recalculated. - [Update line item quantity](https://spreecommerce.org/docs/api-reference/store-api/carts/update-line-item-quantity.md): Updates the quantity of a line item in the cart - [Update payment session](https://spreecommerce.org/docs/api-reference/store-api/carts/update-payment-session.md): Updates a payment session. Delegates to the payment gateway to sync changes with the provider. - [Complete payment setup session](https://spreecommerce.org/docs/api-reference/store-api/customers/complete-payment-setup-session.md): Completes a payment setup session by confirming the setup with the provider, resulting in a saved payment method. - [Create an address](https://spreecommerce.org/docs/api-reference/store-api/customers/create-an-address.md): Adds a new address to the customer address book - [Create payment setup session](https://spreecommerce.org/docs/api-reference/store-api/customers/create-payment-setup-session.md): Creates a new payment setup session for saving a payment method for future use. Delegates to the payment gateway to initialize a provider-specific setup flow (e.g. Stripe SetupIntent, Adyen zero-auth tokenization). - [Delete a credit card](https://spreecommerce.org/docs/api-reference/store-api/customers/delete-a-credit-card.md): Removes a saved credit card from the customer account - [Delete an address](https://spreecommerce.org/docs/api-reference/store-api/customers/delete-an-address.md) - [Get a credit card](https://spreecommerce.org/docs/api-reference/store-api/customers/get-a-credit-card.md): Returns a saved credit card by its ID - [Get a gift card](https://spreecommerce.org/docs/api-reference/store-api/customers/get-a-gift-card.md): Returns a gift card by its ID - [Get a store credit](https://spreecommerce.org/docs/api-reference/store-api/customers/get-a-store-credit.md) - [Get an address](https://spreecommerce.org/docs/api-reference/store-api/customers/get-an-address.md) - [Get an order](https://spreecommerce.org/docs/api-reference/store-api/customers/get-an-order.md): Returns a single completed order for the authenticated customer. - [Get current customer profile](https://spreecommerce.org/docs/api-reference/store-api/customers/get-current-customer-profile.md): Returns the profile of the currently authenticated customer - [Get payment setup session](https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session.md): Returns a payment setup session with its current status and provider data. - [List customer addresses](https://spreecommerce.org/docs/api-reference/store-api/customers/list-customer-addresses.md): Returns all addresses in the customer address book - [List gift cards](https://spreecommerce.org/docs/api-reference/store-api/customers/list-gift-cards.md): Returns all gift cards for the authenticated customer - [List orders](https://spreecommerce.org/docs/api-reference/store-api/customers/list-orders.md): Returns a paginated list of completed orders for the authenticated customer. - [List saved credit cards](https://spreecommerce.org/docs/api-reference/store-api/customers/list-saved-credit-cards.md): Returns all saved credit cards for the authenticated customer - [List store credits](https://spreecommerce.org/docs/api-reference/store-api/customers/list-store-credits.md): Returns store credits for the authenticated customer, filtered by current store and currency. Supports Ransack filtering. - [Register a new customer](https://spreecommerce.org/docs/api-reference/store-api/customers/register-a-new-customer.md): Creates a new customer account and returns a JWT token - [Update an address](https://spreecommerce.org/docs/api-reference/store-api/customers/update-an-address.md) - [Update current customer profile](https://spreecommerce.org/docs/api-reference/store-api/customers/update-current-customer-profile.md): Updates the profile of the currently authenticated customer - [Download a digital product](https://spreecommerce.org/docs/api-reference/store-api/digitals/download-a-digital-product.md): Downloads a digital product file using the digital link token. The token is provided via the `download_url` field on digital links returned with order line items. No API key or authentication required — the token itself grants access. Each download increments the access counter. Downloads may be lim… - [Errors](https://spreecommerce.org/docs/api-reference/store-api/errors.md): Error response format, error codes, and handling strategies - [Idempotency](https://spreecommerce.org/docs/api-reference/store-api/idempotency.md): Prevent duplicate operations with idempotency keys - [Store API](https://spreecommerce.org/docs/api-reference/store-api/introduction.md) - [Localization](https://spreecommerce.org/docs/api-reference/store-api/localization.md): How to set locale, currency, and country for API requests - [Get a country](https://spreecommerce.org/docs/api-reference/store-api/markets/get-a-country.md): Returns a single country by ISO code. Supports ?expand=states for address forms and ?expand=market for market details. - [Get a country in a market](https://spreecommerce.org/docs/api-reference/store-api/markets/get-a-country-in-a-market.md): Returns a single country by ISO code within a market. Supports ?expand=states for address forms. - [Get a market](https://spreecommerce.org/docs/api-reference/store-api/markets/get-a-market.md): Returns a single market by prefixed ID with its countries, currency, locales, and tax configuration. - [List countries](https://spreecommerce.org/docs/api-reference/store-api/markets/list-countries.md): Returns countries available in the store. Use ?expand=market to include market details (currency, locale, tax_inclusive). - [List countries in a market](https://spreecommerce.org/docs/api-reference/store-api/markets/list-countries-in-a-market.md): Returns countries belonging to a specific market. Use this for address form country dropdowns during checkout. - [List markets](https://spreecommerce.org/docs/api-reference/store-api/markets/list-markets.md): Returns all markets for the current store with their countries, currency, locales, and tax configuration. - [List supported currencies](https://spreecommerce.org/docs/api-reference/store-api/markets/list-supported-currencies.md): Returns currencies supported by the store (derived from markets) - [List supported locales](https://spreecommerce.org/docs/api-reference/store-api/markets/list-supported-locales.md): Returns locales supported by the store (derived from markets) - [Resolve market by country](https://spreecommerce.org/docs/api-reference/store-api/markets/resolve-market-by-country.md): Determine which market applies for a given country ISO code. Useful for auto-selecting the correct currency and locale when a customer's location is known. - [Metadata](https://spreecommerce.org/docs/api-reference/store-api/metadata.md): How to store and retrieve custom metadata on carts, orders, and line items - [Monetary Amounts](https://spreecommerce.org/docs/api-reference/store-api/monetary-amounts.md): How monetary values are represented in API responses - [Get an order](https://spreecommerce.org/docs/api-reference/store-api/orders/get-an-order.md): Returns a single completed order by prefixed ID. Accessible via JWT (authenticated users) or order token header (guests). - [Get a policy](https://spreecommerce.org/docs/api-reference/store-api/policies/get-a-policy.md): Returns a single policy by slug or prefixed ID. Includes the full rich text body. - [List store policies](https://spreecommerce.org/docs/api-reference/store-api/policies/list-store-policies.md): Returns all policies for the current store (e.g., return policy, privacy policy, terms of service). Policies are managed in Spree Admin and contain rich text content. - [Get a category](https://spreecommerce.org/docs/api-reference/store-api/product-catalog/get-a-category.md): Returns a single category by permalink or prefix ID - [Get a product](https://spreecommerce.org/docs/api-reference/store-api/product-catalog/get-a-product.md): Returns a single product by slug or prefix ID - [Get product filters](https://spreecommerce.org/docs/api-reference/store-api/product-catalog/get-product-filters.md): Returns available filters for products with their options and counts. Use this endpoint to build filter UIs for product listing pages. - [List categories](https://spreecommerce.org/docs/api-reference/store-api/product-catalog/list-categories.md): Returns a paginated list of categories for the current store - [List products](https://spreecommerce.org/docs/api-reference/store-api/product-catalog/list-products.md): Returns a paginated list of active products for the current store - [Querying](https://spreecommerce.org/docs/api-reference/store-api/querying.md): How to filter, sort, and paginate Store API results using Ransack - [Rate Limiting](https://spreecommerce.org/docs/api-reference/store-api/rate-limitting.md): Rate limits and throttling for the Store API - [Relations](https://spreecommerce.org/docs/api-reference/store-api/relations.md): How to include related resources in API responses - [Add item to wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/add-item-to-wishlist.md): Adds a variant to the wishlist - [Create a wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/create-a-wishlist.md): Creates a new wishlist for the customer - [Delete a wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/delete-a-wishlist.md) - [Get a wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/get-a-wishlist.md) - [List wishlists](https://spreecommerce.org/docs/api-reference/store-api/wishlists/list-wishlists.md): Returns all wishlists for the authenticated customer - [Remove item from wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/remove-item-from-wishlist.md) - [Update a wishlist](https://spreecommerce.org/docs/api-reference/store-api/wishlists/update-a-wishlist.md) - [Create an Address](https://spreecommerce.org/docs/api-reference/storefront/account-address/create-an-address.md): Creates a new address for the current user. - [List all Addresses](https://spreecommerce.org/docs/api-reference/storefront/account-address/list-all-addresses.md): Returns a list of addresses for the current user. - [Remove an Address](https://spreecommerce.org/docs/api-reference/storefront/account-address/remove-an-address.md): This endpoint removes the specified address for the current user. It uses a soft delete to retain address information for pre-existing orders. - [Update an Address](https://spreecommerce.org/docs/api-reference/storefront/account-address/update-an-address.md): Updates the specified address for the current user. - [List all Credit Cards](https://spreecommerce.org/docs/api-reference/storefront/account-credit-cards/list-all-credit-cards.md): Returns a list of credit cards for the current user. - [Remove a Credit Card](https://spreecommerce.org/docs/api-reference/storefront/account-credit-cards/remove-a-credit-card.md): Removes a specified credit card for the current user with a soft delete to retain payment information for any pre-existing orders. - [Retrieve the default Credit Card](https://spreecommerce.org/docs/api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card.md): Returns the current user's default credit card. - [List all Orders](https://spreecommerce.org/docs/api-reference/storefront/account-orders/list-all-orders.md): Returns all completed orders placed by the current user in the current store. - [Retrieve an Order](https://spreecommerce.org/docs/api-reference/storefront/account-orders/retrieve-an-order.md): Returns a completed order for the current user within the scope of the current store. - [Create an Account](https://spreecommerce.org/docs/api-reference/storefront/account/create-an-account.md): Creates a new account - [Retrieve an Account](https://spreecommerce.org/docs/api-reference/storefront/account/retrieve-an-account.md): Returns the current user details. - [Update an Account](https://spreecommerce.org/docs/api-reference/storefront/account/update-an-account.md): Updates the users account details - [Complete an Adyen payment session and order](https://spreecommerce.org/docs/api-reference/storefront/adyen/complete-an-adyen-payment-session-and-order.md): Complete an Adyen payment session and order. Adyen support is currently in private beta. [Please contact us](https://spreecommerce.org/contact) to get access. - [Create an Adyen Payment Session](https://spreecommerce.org/docs/api-reference/storefront/adyen/create-an-adyen-payment-session.md): Create a new Adyen payment session with the specified amount. Adyen support is currently in private beta. [Please contact us](https://spreecommerce.org/contact) to get access. - [Get Adyen Payment Session](https://spreecommerce.org/docs/api-reference/storefront/adyen/get-adyen-payment-session.md): Retrieve An Adyen payment session information. Adyen support is currently in private beta. [Please contact us](https://spreecommerce.org/contact) to get access. - [Authentication](https://spreecommerce.org/docs/api-reference/storefront/authentication.md): Learn how to authenticate requests to the Storefront API. - [Apply a Coupon Code / Gift Card](https://spreecommerce.org/docs/api-reference/storefront/cart-coupons/apply-a-coupon-code-gift-card.md): Applies a coupon code or gift card code to the current cart. - [Remove a Coupon / Gift Card](https://spreecommerce.org/docs/api-reference/storefront/cart-coupons/remove-a-coupon-gift-card.md): Removes a specified coupon code or gift card code from the current cart. - [Remove all Coupons](https://spreecommerce.org/docs/api-reference/storefront/cart-coupons/remove-all-coupons.md): Removes all coupons that have been applied to the current cart. - [Add an Item to Cart](https://spreecommerce.org/docs/api-reference/storefront/cart-line-items/add-an-item-to-cart.md): Adds a variant to the current cart by creating a line item. Each line item represents a specified variant and the desired quantity. - [Remove a Line Item](https://spreecommerce.org/docs/api-reference/storefront/cart-line-items/remove-a-line-item.md): Removes a line item from the cart by deleting the line item. - [Set Line Item Quantity](https://spreecommerce.org/docs/api-reference/storefront/cart-line-items/set-line-item-quantity.md): Sets the quantity of a specified line item. - [Associate a Cart with a User](https://spreecommerce.org/docs/api-reference/storefront/cart-other/associate-a-cart-with-a-user.md): Associates a guest cart with the currently signed in user. - [Change Cart Currency](https://spreecommerce.org/docs/api-reference/storefront/cart-other/change-cart-currency.md): Changes the cart currency and recalculates the cart values. - [Empty the Cart](https://spreecommerce.org/docs/api-reference/storefront/cart-other/empty-the-cart.md): This endpoint removed all line items from the cart. Inventory that was previously taken by this order will be re-stocked. - [List Estimated Shipping Rates](https://spreecommerce.org/docs/api-reference/storefront/cart-other/list-estimated-shipping-rates.md): Returns a list of shipping rates for the current cart. The rates given are only estimates and can vary from the final shipping rates. - [Create a Cart](https://spreecommerce.org/docs/api-reference/storefront/cart/create-a-cart.md): Creates a new cart. - [Delete a Cart](https://spreecommerce.org/docs/api-reference/storefront/cart/delete-a-cart.md): Deletes a specified cart. - [Retrieve a Cart](https://spreecommerce.org/docs/api-reference/storefront/cart/retrieve-a-cart.md): Returns the cart for the current user. - [Create new Payment](https://spreecommerce.org/docs/api-reference/storefront/checkout-payments/create-new-payment.md): Creates new Payment for the current checkout. - [List Payment Methods](https://spreecommerce.org/docs/api-reference/storefront/checkout-payments/list-payment-methods.md): Returns a list of available payment methods for this checkout. - [List Shipping Rates](https://spreecommerce.org/docs/api-reference/storefront/checkout-shipments/list-shipping-rates.md): Returns a list of available shipping rates for the checkout. - [Selects shipping method for shipment(s)](https://spreecommerce.org/docs/api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments.md): Selects shipping method for Shipment(s). - [Advance Checkout](https://spreecommerce.org/docs/api-reference/storefront/checkout-state/advance-checkout.md): Advances the checkout to the furthest checkout step validation allows, up until the **completed** step. - [Complete Checkout](https://spreecommerce.org/docs/api-reference/storefront/checkout-state/complete-checkout.md): Completes the checkout by marking the order as complete. - [Next Checkout Step](https://spreecommerce.org/docs/api-reference/storefront/checkout-state/next-checkout-step.md): Goes to the next checkout step. - [Add Store Credit](https://spreecommerce.org/docs/api-reference/storefront/checkout-store-credit/add-store-credit.md): The Add Store Credit endpoint takes the users existing store credit from their account and adds a set amount of this store credit to the current cart. - [Remove Store Credit](https://spreecommerce.org/docs/api-reference/storefront/checkout-store-credit/remove-store-credit.md): Removes store credit from the cart if any had previously been applied. - [Update Checkout](https://spreecommerce.org/docs/api-reference/storefront/checkout/update-checkout.md): The Update Checkout endpoint allows you to manage the typical stages of an e-commerce checkout system. - [Validate order payment](https://spreecommerce.org/docs/api-reference/storefront/checkout/validate-order-payment.md): Validate an order before placing it. It will respond with an error when: - cart was changed - any order item is out of stock - any order item is discontinued - [Get Default Country](https://spreecommerce.org/docs/api-reference/storefront/countries/get-default-country.md): Returns the default country for the current store. By default this will be the US. - [List all Countries](https://spreecommerce.org/docs/api-reference/storefront/countries/list-all-countries.md): Returns a list of all countries. - [Retrieve a Country](https://spreecommerce.org/docs/api-reference/storefront/countries/retrieve-a-country.md): Returns the details of a specific country. - [Download a Digital Asset](https://spreecommerce.org/docs/api-reference/storefront/digital-downloads/download-a-digital-asset.md): This endpoint allows you to download a digital item using the unique digital_link token. - [Retrieve an Order Status](https://spreecommerce.org/docs/api-reference/storefront/order-status/retrieve-an-order-status.md): Returns completed order information. - [List all Store Policies](https://spreecommerce.org/docs/api-reference/storefront/policies/list-all-store-policies.md): Returns a list of Store Policies. This endpoint is only available in Spree 5.2 or later. - [Retrieve a Policy](https://spreecommerce.org/docs/api-reference/storefront/policies/retrieve-a-policy.md): Returns the details of a specified Policy. This endpoint is only available in Spree 5.2 or later. - [List all Post Categories](https://spreecommerce.org/docs/api-reference/storefront/post-categories/list-all-post-categories.md): Returns a list of Post Categories. This endpoint is only available in Spree 5.2 or later. - [Retrieve a Post Category](https://spreecommerce.org/docs/api-reference/storefront/post-categories/retrieve-a-post-category.md): Returns the details of a specified Post Category, including related posts. You can use either the category slug or ID. This endpoint is only available in Spree 5.2 or later. - [List all Posts](https://spreecommerce.org/docs/api-reference/storefront/posts/list-all-posts.md): Returns a list of published Posts. This endpoint is only available in Spree 5.2 or later. - [Retrieve a Post](https://spreecommerce.org/docs/api-reference/storefront/posts/retrieve-a-post.md): Returns the details of a specified Post. You can use either the post slug or ID. This endpoint is only available in Spree 5.2 or later. - [List all Products](https://spreecommerce.org/docs/api-reference/storefront/products/list-all-products.md): Returns a list of products for the current Store. - [Retrieve a Product](https://spreecommerce.org/docs/api-reference/storefront/products/retrieve-a-product.md): Returns Product details. You can use product permalink: - [Return the current Store](https://spreecommerce.org/docs/api-reference/storefront/stores/return-the-current-store.md): Returns the current Store. [Read more about Stores](/developer/core-concepts/stores) - [Create a Stripe Payment Intent](https://spreecommerce.org/docs/api-reference/storefront/stripe/create-a-stripe-payment-intent.md): Create a Stripe Payment Intent using provided payment method. It creates a Stripe customer if not exists. - [Create a Stripe Setup Intent](https://spreecommerce.org/docs/api-reference/storefront/stripe/create-a-stripe-setup-intent.md): First, this endpoint creates a customer in Stripe (if it doesn't already exist), then it creates an Ephemeral Key for the customer, and finally, it creates a Setup Intent for the customer. - [Mark the payment intent as confirmed, and move the order to the complete state](https://spreecommerce.org/docs/api-reference/storefront/stripe/mark-the-payment-intent-as-confirmed-and-move-the-order-to-the-complete-state.md): This endpoint is used to complete the order with succeeded payment intent. First it will check if the payment intent has `status` `succeeded`, if yes, then it will move the order to the complete state. - [Return a Stripe Payment Intent](https://spreecommerce.org/docs/api-reference/storefront/stripe/return-a-stripe-payment-intent.md): Returns the Payment Intent information - [Updates Stripe Payment Intent](https://spreecommerce.org/docs/api-reference/storefront/stripe/updates-stripe-payment-intent.md): Updates the payment intent with new `amount` and `stripe_payment_method_id` - [List all Taxons](https://spreecommerce.org/docs/api-reference/storefront/taxons/list-all-taxons.md): Returns a list of Taxons. [Read more about Taxons](/developer/core-concepts/products#taxons-and-taxonomies) - [Retrieve a Taxon](https://spreecommerce.org/docs/api-reference/storefront/taxons/retrieve-a-taxon.md): Returns the details of a specified taxon. - [List all Product Variants](https://spreecommerce.org/docs/api-reference/storefront/variants/list-all-product-variants.md): Returns a list of product variants. You can use product permalink: - [List all Vendors](https://spreecommerce.org/docs/api-reference/storefront/vendors/list-all-vendors.md): Returns a list of Vendors. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Retrieve a Vendor](https://spreecommerce.org/docs/api-reference/storefront/vendors/retrieve-a-vendor.md): Returns the details of a specified Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing) - [Add Item to Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists-wished-items/add-item-to-wishlist.md): The Add Item to Wishlist endpoint adds a variant to an existing wishlist by creating a new `wished_item`. A wished item in a wishlist is comparable to a line item in a cart. - [Add Items to Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists-wished-items/add-items-to-wishlist.md): The Add Items to Wishlist endpoint adds variants to an existing wishlist by creating a new `wished_item` objects. A wished item in a wishlist is comparable to a line item in a cart. - [Delete Item from Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist.md): Removes a wished item from a wishlist. - [Delete Items from Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist.md): Removes wished items from a wishlist. - [Set Wished Item Quantity](https://spreecommerce.org/docs/api-reference/storefront/wishlists-wished-items/set-wished-item-quantity.md): This endpoint sets the wished item quantity. - [Create a Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists/create-a-wishlist.md): Creates a new wishlist for the current user in the current store. - [Delete a Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists/delete-a-wishlist.md): This operation deletes the wishlist identified in the URI `token`. - [List all Wishlists](https://spreecommerce.org/docs/api-reference/storefront/wishlists/list-all-wishlists.md): Returns all wishlists available to the current user, in the current store. - [Retrieve a Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists/retrieve-a-wishlist.md): Retrieves a wishlist using the wishlist token. - [Retrieve the default Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists/retrieve-the-default-wishlist.md): Returns the default wishlist for the current user, in the current store. If the user does not have a default wishlist in the current store one will be created. - [Update a Wishlist](https://spreecommerce.org/docs/api-reference/storefront/wishlists/update-a-wishlist.md): Updates the specific Wishlist by setting the values passed in the request body. Any parameters not provided will be left unchanged. - [Adyen Integration Guide for Android](https://spreecommerce.org/docs/api-reference/tutorials/adyen-integration-guide-for-android.md): This guide provides step-by-step instructions for integrating Adyen Android Drop-in with spree_adyen using session flow and Drop-In component. - [Adyen Integration Guide for iOS](https://spreecommerce.org/docs/api-reference/tutorials/adyen-integration-guide-for-ios.md): This guide provides step-by-step instructions for integrating Adyen iOS Drop-in with spree_adyen using session flow and Drop-In component. - [Quick Checkout with Stripe and Storefront API](https://spreecommerce.org/docs/api-reference/tutorials/quick-checkout-with-stripe.md): This tutorial will show you how to add quick checkout to your headless/composable storefront using Stripe and Spree APIs. - [Fetching multiple resources](https://spreecommerce.org/docs/api-reference/v2/fetching-multiple-resources.md) - [Filtering and sorting](https://spreecommerce.org/docs/api-reference/v2/filtering-and-sorting.md) - [Ecommerce API](https://spreecommerce.org/docs/api-reference/v2/introduction.md): Spree open-source comes with a fully-featured Ecommerce API for headless eCommerce apps. - [Pagination](https://spreecommerce.org/docs/api-reference/v2/pagination.md) - [Webhook Events & Payloads](https://spreecommerce.org/docs/api-reference/webhooks-events.md): Complete reference of all webhook event types and their payload schemas - [Admin Dashboard](https://spreecommerce.org/docs/developer/admin/admin.md): Learn how to customize and extend the Spree Admin Dashboard - [Admin Panel Authentication](https://spreecommerce.org/docs/developer/admin/authentication.md): How to customize the Spree admin panel authentication - [Admin Components](https://spreecommerce.org/docs/developer/admin/components.md) - [Admin Dashboard Custom CSS](https://spreecommerce.org/docs/developer/admin/custom-css.md) - [Custom JavaScript for Admin Dashboard](https://spreecommerce.org/docs/developer/admin/custom-javascript.md): Learn how to add custom JavaScript to your Spree Admin Dashboard - [Extending Admin Dashboard UI](https://spreecommerce.org/docs/developer/admin/extending-ui.md) - [Admin Form Builder API](https://spreecommerce.org/docs/developer/admin/form-builder.md) - [Admin Dashboard Helper Methods](https://spreecommerce.org/docs/developer/admin/helper-methods.md) - [Extending Admin Navigation](https://spreecommerce.org/docs/developer/admin/navigation.md) - [Admin Tables](https://spreecommerce.org/docs/developer/admin/tables.md) - [Spree CLI](https://spreecommerce.org/docs/developer/cli/quickstart.md): Manage your Spree Commerce project from the command line. - [Creating an Extension](https://spreecommerce.org/docs/developer/contributing/creating-an-extension.md): Learn how to create a Spree extension. - [Developing Spree](https://spreecommerce.org/docs/developer/contributing/developing-spree.md): This guide covers all the necessary steps to contributing to Spree source code. We're happy you're here! - [Quickstart](https://spreecommerce.org/docs/developer/contributing/quickstart.md): How to get started contributing to Spree - [Addresses](https://spreecommerce.org/docs/developer/core-concepts/addresses.md): Addresses, countries, states, and zones — how geography drives checkout, taxes, and shipping - [Adjustments](https://spreecommerce.org/docs/developer/core-concepts/adjustments.md): How taxes, promotions, and other price modifications are applied to orders - [Architecture](https://spreecommerce.org/docs/developer/core-concepts/architecture.md): How Spree's core models, APIs, and packages work together - [Calculators](https://spreecommerce.org/docs/developer/core-concepts/calculators.md) - [Customers](https://spreecommerce.org/docs/developer/core-concepts/customers.md): Customer accounts — registration, authentication, profiles, and guest checkout - [Events](https://spreecommerce.org/docs/developer/core-concepts/events.md): Learn how Spree's event system works and how to subscribe to events. - [Imports & Exports](https://spreecommerce.org/docs/developer/core-concepts/imports-exports.md) - [Inventory](https://spreecommerce.org/docs/developer/core-concepts/inventory.md): Stock locations, stock items, stock movements, and inventory tracking - [Markets](https://spreecommerce.org/docs/developer/core-concepts/markets.md): Multi-region commerce with Markets — bundle geography, currency, and locale into distinct selling regions within a single store. - [Media](https://spreecommerce.org/docs/developer/core-concepts/media.md): Product media (images, videos), named variants, focal points, and how media is served via the Store API - [Metafields](https://spreecommerce.org/docs/developer/core-concepts/metafields.md): Add custom structured data to products, orders, and other resources with type-safe metafields - [Orders](https://spreecommerce.org/docs/developer/core-concepts/orders.md): Order lifecycle, checkout flow, line items, payments, and shipments - [Payments](https://spreecommerce.org/docs/developer/core-concepts/payments.md) - [Pricing](https://spreecommerce.org/docs/developer/core-concepts/pricing.md): Prices, Price Lists, Price Rules, and the Pricing Context — Spree's flexible pricing engine for regional, wholesale, volume, and market-based pricing. - [Products](https://spreecommerce.org/docs/developer/core-concepts/products.md): Products, variants, option types, images, prices, and categories - [Promotions](https://spreecommerce.org/docs/developer/core-concepts/promotions.md): Learn about Spree's flexible promotion system for discounts, free shipping, and gifts. - [Reports](https://spreecommerce.org/docs/developer/core-concepts/reports.md) - [Search & Filtering](https://spreecommerce.org/docs/developer/core-concepts/search-filtering.md): Search, filter, and sort products and other resources via the Store API - [Shipments](https://spreecommerce.org/docs/developer/core-concepts/shipments.md): Shipping methods, rates, split shipments, and fulfillment - [Slugs](https://spreecommerce.org/docs/developer/core-concepts/slugs.md): SEO-friendly URL identifiers for products, categories, and other resources - [Staff & Roles](https://spreecommerce.org/docs/developer/core-concepts/staff-roles.md): Admin users, roles, invitations, and permissions - [Store Credits & Gift Cards](https://spreecommerce.org/docs/developer/core-concepts/store-credits-gift-cards.md): Stored value mechanisms for refunds, loyalty rewards, and gifting - [Stores](https://spreecommerce.org/docs/developer/core-concepts/stores.md): The central model in Spree — every resource is scoped to a store - [Taxes](https://spreecommerce.org/docs/developer/core-concepts/taxes.md): Tax categories, tax rates, zones, and how Spree calculates taxes at checkout - [Translations](https://spreecommerce.org/docs/developer/core-concepts/translations.md): Translate product content and other resources into multiple languages - [Webhooks](https://spreecommerce.org/docs/developer/core-concepts/webhooks.md): Send real-time HTTP notifications to external services when events occur in your store. - [create-spree-app](https://spreecommerce.org/docs/developer/create-spree-app/quickstart.md): Scaffold a new Spree Commerce project with a single command. Includes a full Rails backend app for customization. - [API](https://spreecommerce.org/docs/developer/customization/api.md): Add new Store API endpoints and customize existing API responses - [Authentication](https://spreecommerce.org/docs/developer/customization/authentication.md): Learn how to use a custom authentication setup with Spree - [Checkout Flow](https://spreecommerce.org/docs/developer/customization/checkout.md): Learn how to customize the checkout process in Spree. - [Configuration](https://spreecommerce.org/docs/developer/customization/configuration.md) - [Decorators](https://spreecommerce.org/docs/developer/customization/decorators.md): Decorators allow you to add or modify behavior of Spree classes in your application. - [Dependencies](https://spreecommerce.org/docs/developer/customization/dependencies.md) - [Extensions](https://spreecommerce.org/docs/developer/customization/extensions.md): Extensions provide additional features and integrations for your Spree application. Here's a list of the most popular ones. - [Metadata](https://spreecommerce.org/docs/developer/customization/metadata.md) - [Model Preferences](https://spreecommerce.org/docs/developer/customization/model-preferences.md) - [Permissions](https://spreecommerce.org/docs/developer/customization/permissions.md) - [Quickstart](https://spreecommerce.org/docs/developer/customization/quickstart.md): Learn how to customize every part of the Spree stack - [Routes](https://spreecommerce.org/docs/developer/customization/routes.md): Learn how to customize the routes in Spree - [Assets](https://spreecommerce.org/docs/developer/deployment/assets.md) - [Amazon Web Services (AWS)](https://spreecommerce.org/docs/developer/deployment/aws.md): Learn how to deploy your Spree application on Amazon Web Services (AWS). - [Caching](https://spreecommerce.org/docs/developer/deployment/caching.md): Configure caching for your Spree application - [CDN](https://spreecommerce.org/docs/developer/deployment/cdn.md): Learn how to improve performance of your Spree application by using a CDN (Content Delivery Network). - [Database Configuration](https://spreecommerce.org/docs/developer/deployment/database.md): Learn how to configure Spree to work with PostgreSQL, MySQL, or SQLite. - [Docker](https://spreecommerce.org/docs/developer/deployment/docker.md): Run the official Spree Docker image or build your own. - [Sending out Emails](https://spreecommerce.org/docs/developer/deployment/emails.md): Learn how to send transactional emails from your Spree application. - [Environment Variables](https://spreecommerce.org/docs/developer/deployment/environment_variables.md) - [Render](https://spreecommerce.org/docs/developer/deployment/render.md): Deploy Spree to Render with one click. - [Installing Spree](https://spreecommerce.org/docs/developer/getting-started/quickstart.md): Follow the instructions below to learn how to build and deploy your Spree application. - [Build a Custom Payment Method](https://spreecommerce.org/docs/developer/how-to/custom-payment-method.md): Step-by-step guide to creating a custom payment gateway integration with Payment Sessions, 3D Secure, and PCI compliance. - [Build Custom Promotion Rules & Actions](https://spreecommerce.org/docs/developer/how-to/custom-promotion.md): Step-by-step guide to creating custom promotion rules and actions for business-specific eligibility logic and discount behaviors. - [Build a Custom Report](https://spreecommerce.org/docs/developer/how-to/custom-report.md): Step-by-step guide to creating custom reports with data queries, line item formatters, and CSV export. - [Build a Custom Search Provider](https://spreecommerce.org/docs/developer/how-to/custom-search-provider.md): Step-by-step guide to building a custom search provider for Spree, integrating external search engines like Typesense, Algolia, or Elasticsearch. - [Multi-Store Spree Commerce](https://spreecommerce.org/docs/developer/multi-store/quickstart.md) - [Multi-Store Setup](https://spreecommerce.org/docs/developer/multi-store/setup.md) - [Spree Multi Tenant Configuration](https://spreecommerce.org/docs/developer/multi-tenant/configuration.md) - [Multi-Tenant Core Concepts](https://spreecommerce.org/docs/developer/multi-tenant/core-concepts.md) - [Spree Multi Tenant Installation](https://spreecommerce.org/docs/developer/multi-tenant/installation.md): Learn how to setup a multi-tenant eCommerce (SaaS) with Spree - [Building a Multi-Tenant Spree Application](https://spreecommerce.org/docs/developer/multi-tenant/quickstart.md) - [Spree Multi Vendor Installation](https://spreecommerce.org/docs/developer/multi-vendor/installation.md): Learn how to setup a multi-vendor marketplace with Spree - [Building a Multi-Vendor Marketplace with Spree](https://spreecommerce.org/docs/developer/multi-vendor/quickstart.md) - [Admin API](https://spreecommerce.org/docs/developer/sdk/admin/quickstart.md): Manage your store programmatically with the Spree Admin SDK - [Authentication](https://spreecommerce.org/docs/developer/sdk/authentication.md): Authentication modes and guest checkout with the Spree SDK - [Configuration](https://spreecommerce.org/docs/developer/sdk/configuration.md): Localization, error handling, TypeScript types, and custom fetch - [Custom Endpoints](https://spreecommerce.org/docs/developer/sdk/extending.md): Call custom Store API endpoints using the SDK's built-in request method - [Quickstart](https://spreecommerce.org/docs/developer/sdk/quickstart.md): Install and start using the Spree SDK in your project - [Customer Account](https://spreecommerce.org/docs/developer/sdk/store/account.md): Manage customer profiles, addresses, and credit cards with the Spree SDK - [Cart, Checkout & Orders](https://spreecommerce.org/docs/developer/sdk/store/cart-checkout.md): Manage carts, line items, coupons, checkout flow, and completed orders with the Spree SDK - [Markets](https://spreecommerce.org/docs/developer/sdk/store/markets.md): Fetch markets, resolve by country, and list market countries with the Spree SDK - [Payments & Delivery](https://spreecommerce.org/docs/developer/sdk/store/payments.md): Handle payments, payment sessions, and delivery with the Spree SDK - [Products & Categories](https://spreecommerce.org/docs/developer/sdk/store/products.md): Browse products and categories with the Spree SDK - [Wishlists](https://spreecommerce.org/docs/developer/sdk/store/wishlists.md): Manage wishlists and wished items with the Spree SDK - [PCI Compliance](https://spreecommerce.org/docs/developer/security/pci_compliance.md) - [Security Policy](https://spreecommerce.org/docs/developer/security/security_policy.md): How to report vulnerabilities, supported versions, and Spree's security practices. - [Architecture](https://spreecommerce.org/docs/developer/storefront/nextjs/architecture.md): Server-first architecture, project structure, and auth flow - [Customization](https://spreecommerce.org/docs/developer/storefront/nextjs/customization.md): Fork, customize, and extend the Spree Next.js Storefront - [Deployment](https://spreecommerce.org/docs/developer/storefront/nextjs/deployment.md): Deploy the Spree Next.js Storefront to Vercel, Docker, or any Node.js host - [Quickstart](https://spreecommerce.org/docs/developer/storefront/nextjs/quickstart.md): Get started with the Spree Next.js Storefront - [Admin Dashboard](https://spreecommerce.org/docs/developer/tutorial/admin.md): Learn how to create Admin Dashboard UI to manage Brands - [Extending Core Models](https://spreecommerce.org/docs/developer/tutorial/extending-models.md): Learn how to extend Spree's core models to connect Brands with Products - [File Uploads](https://spreecommerce.org/docs/developer/tutorial/file-uploads.md): Learn how to add file uploads to the Brands feature - [Tutorial](https://spreecommerce.org/docs/developer/tutorial/introduction.md): Learn how to build a custom feature from scratch, covering models, Admin dashboard and API. - [Model](https://spreecommerce.org/docs/developer/tutorial/model.md): Learn how to create a database model for the Brands feature - [Rich Text](https://spreecommerce.org/docs/developer/tutorial/rich-text.md): Learn how to add rich text content to the Brands feature using Action Text - [SDK](https://spreecommerce.org/docs/developer/tutorial/sdk.md): Use the TypeScript SDK to consume your custom Brand endpoints and extended Product data - [Store API](https://spreecommerce.org/docs/developer/tutorial/store-api.md): Expose your Brand model through the Store API with serializers, controllers, and routes - [Testing](https://spreecommerce.org/docs/developer/tutorial/testing.md) - [2.0 to 2.1](https://spreecommerce.org/docs/developer/upgrades/2.0-to-2.1.md): This guide covers upgrading a 2.0 Spree store, to a 2.1 store. - [2.1 to 2.2](https://spreecommerce.org/docs/developer/upgrades/2.1-to-2.2.md): This guide covers upgrading a 2.1 Spree store, to a 2.2 store. - [2.2 to 2.3](https://spreecommerce.org/docs/developer/upgrades/2.2-to-2.3.md): This guide covers upgrading a 2.2 Spree store, to a 2.3 store. - [2.3 to 2.4](https://spreecommerce.org/docs/developer/upgrades/2.3-to-2.4.md): This guide covers upgrading a 2.3 Spree store, to a 2.4 store. - [3.0 to 3.1](https://spreecommerce.org/docs/developer/upgrades/3.0-to-3.1.md): This guide covers upgrading a 3.0 Spree store, to a 3.1 store - [3.1 to 3.2](https://spreecommerce.org/docs/developer/upgrades/3.1-to-3.2.md): This guide covers upgrading a 3.1 Spree store, to a 3.2 store. - [3.2 to 3.3](https://spreecommerce.org/docs/developer/upgrades/3.2-to-3.3.md): This guide covers upgrading a 3.2 Spree store, to a 3.3 store. - [3.3 to 3.4](https://spreecommerce.org/docs/developer/upgrades/3.3-to-3.4.md): This guide covers upgrading a 3.3 Spree store, to a 3.4 store. - [3.4 to 3.5](https://spreecommerce.org/docs/developer/upgrades/3.4-to-3.5.md): This guide covers upgrading a 3.4 Spree store, to a 3.5 store. - [3.5 to 3.6](https://spreecommerce.org/docs/developer/upgrades/3.5-to-3.6.md): This guide covers upgrading a 3.5 Spree application, to a 3.6 application. - [3.6 to 3.7](https://spreecommerce.org/docs/developer/upgrades/3.6-to-3.7.md): This guide covers upgrading a 3.6 Spree application, to version 3.7. - [3.7 to 4.0](https://spreecommerce.org/docs/developer/upgrades/3.7-to-4.0.md): This guide covers upgrading a 3.7 Spree application to Spree 4.0. - [4.0 to 4.1](https://spreecommerce.org/docs/developer/upgrades/4.0-to-4.1.md): This guide covers upgrading a 4.0 Spree application to Spree 4.1. - [4.1 to 4.2](https://spreecommerce.org/docs/developer/upgrades/4.1-to-4.2.md): This guide covers upgrading a 4.1 Spree application to Spree 4.2. - [Upgrading to Spree 5.0](https://spreecommerce.org/docs/developer/upgrades/4.10-to-5.0.md): This guide covers upgrading a Spree 4.10 application to Spree 5.0. - [4.3 to 4.4](https://spreecommerce.org/docs/developer/upgrades/4.3-to-4.4.md): This guide covers upgrading a 4.3 Spree application to Spree 4.4. - [4.4 to 4.5](https://spreecommerce.org/docs/developer/upgrades/4.4-to-4.5.md): This guide covers upgrading a 4.4 Spree application to Spree 4.5 - [4.5 to 4.6](https://spreecommerce.org/docs/developer/upgrades/4.5-to-4.6.md): This guide covers upgrading a 4.5 Spree application to Spree 4.6. - [4.6 to 4.7](https://spreecommerce.org/docs/developer/upgrades/4.6-to-4.7.md): This guide covers upgrading a 4.6 Spree application to Spree 4.7. - [Upgrading to Spree 4.9](https://spreecommerce.org/docs/developer/upgrades/4.8-to-4.9.md): This guide covers upgrading a Spree 4.8 application to Spree 4.9. - [Upgrading to Spree 4.10](https://spreecommerce.org/docs/developer/upgrades/4.9-to-4.10.md): This guide covers upgrading a Spree 4.9 application to Spree 4.10. - [Upgrading to Spree 4.8](https://spreecommerce.org/docs/developer/upgrades/4.x-to-4.8.md): This guide covers upgrading a Spree 4 application to Spree 4.8. - [Upgrading to Spree 5.1](https://spreecommerce.org/docs/developer/upgrades/5.0-to-5.1.md): This guide covers upgrading a Spree 5.0 application to Spree 5.1. - [Upgrading to Spree 5.2](https://spreecommerce.org/docs/developer/upgrades/5.1-to-5.2.md): This guide covers upgrading a Spree 5.1 application to Spree 5.2. - [Upgrading to Spree 5.3](https://spreecommerce.org/docs/developer/upgrades/5.2-to-5.3.md): This guide covers upgrading a Spree 5.2 application to Spree 5.3. - [Upgrading to Spree 5.4](https://spreecommerce.org/docs/developer/upgrades/5.3-to-5.4.md): This guide covers upgrading a Spree 5.3 application to Spree 5.4. - [Quickstart](https://spreecommerce.org/docs/developer/upgrades/quickstart.md): Learn how to upgrade your Spree application - [Connect Google Analytics 4 to Spree Commerce](https://spreecommerce.org/docs/integrations/analytics/google-analytics.md): Learn how to set up and manage Spree’s native Google Analytics 4 integration. - [Connect Google Tag Manager to Spree Commerce](https://spreecommerce.org/docs/integrations/analytics/google-tag-manager.md): Learn how to set up and manage Spree’s native Google Tag Manager integration. - [3rd party integrations](https://spreecommerce.org/docs/integrations/integrations.md): Learn how to connect your Spree application to third-party services and platforms. - [Connect Klaviyo email marketing platform to Spree Commerce](https://spreecommerce.org/docs/integrations/marketing/klaviyo.md): Learn how to set up and manage Spree's native Klaviyo integration. - [Connect Adyen payments to Spree Commerce](https://spreecommerce.org/docs/integrations/payments/adyen.md): Learn how to set up and manage Spree's native Adyen integration. - [Connect PayPal payments to Spree Commerce](https://spreecommerce.org/docs/integrations/payments/paypal.md): Learn how to set up and manage Spree's native PayPal integration. - [Connect Razorpay payments to Spree Commerce](https://spreecommerce.org/docs/integrations/payments/razorpay.md): Configuring Razorpay in Your Spree Store: A Setup & Management Walkthrough. - [Connect Stripe payments to Spree Commerce](https://spreecommerce.org/docs/integrations/payments/stripe.md): Learn how to set up and manage Spree's native Stripe integration. - [Meilisearch](https://spreecommerce.org/docs/integrations/search/meilisearch.md): Set up Meilisearch for fast, typo-tolerant product search with faceted filtering - [SSO and MFA for the Admin Panel](https://spreecommerce.org/docs/integrations/sso-mfa-social-login/admin-dashboard.md): Learn how to secure your Spree admin panel with SSO and MFA integration, using Microsoft Entra ID as an example. - [SSO and Social Login for the Storefront](https://spreecommerce.org/docs/integrations/sso-mfa-social-login/storefront.md): Enable customer-facing SSO and social login on your Spree storefront, using Microsoft Entra External ID as an example. - [B2B Admin Capabilities](https://spreecommerce.org/docs/use-case/b2b/b2b-admin-capabilities.md): Learn how Spree empowers merchants to manage B2B buyers, pricing, and workflows with full flexibility. - [B2B Buyer Experience](https://spreecommerce.org/docs/use-case/b2b/b2b-buyer-capabilities.md): Learn how Spree delivers a seamless and efficient purchasing experience tailored to B2B buyers. - [B2B Capabilities](https://spreecommerce.org/docs/use-case/b2b/b2b-capabilities.md): Learn how Spree Commerce supports advanced B2B commerce operations - [B2B Commerce Model](https://spreecommerce.org/docs/use-case/b2b/b2b-commerce-model.md): Learn about the B2B commerce model. - [ChatGPT Buyer Experience](https://spreecommerce.org/docs/use-case/chatgpt-integration/chatgpt-buyer-experience.md): Learn how ChatGPT makes shopping smarter, faster, and more intuitive for your customers. - [ChatGPT Instant Checkout](https://spreecommerce.org/docs/use-case/chatgpt-integration/chatgpt-instant-checkout.md): Learn how to leverage ChatGPT Instant Checkout with Spree Commerce. - [ChatGPT Shopping](https://spreecommerce.org/docs/use-case/chatgpt-integration/chatgpt-shopping.md): Learn how ChatGPT Shopping works with Spree Commerce. - [Digital Products Admin Capabilities](https://spreecommerce.org/docs/use-case/digital-products/admin-capabilities.md): Learn about the digital product features available in the Spree admin dashboard. - [Digital Products Capabilities](https://spreecommerce.org/docs/use-case/digital-products/capabilities.md): Learn about the digital product features available in Spree Commerce. - [Digital Products Model](https://spreecommerce.org/docs/use-case/digital-products/model.md): Learn about the digital product ecommerce model with Spree Commerce. - [Marketplace Admin Panel](https://spreecommerce.org/docs/use-case/marketplace/admin-dashboard.md): Learn about the Spree multi-vendor marketplace admin UX. - [Marketplace Capabilities](https://spreecommerce.org/docs/use-case/marketplace/capabilities.md): Learn how Spree supports multi-vendor marketplaces. - [Marketplace Customer Experience](https://spreecommerce.org/docs/use-case/marketplace/customer-ux.md): Learn about the Spree multi-vendor marketplace customer UX. - [Marketplace Model](https://spreecommerce.org/docs/use-case/marketplace/model.md): Learn about the multi-vendor marketplace ecommerce model. - [Marketplace Vendor Panel](https://spreecommerce.org/docs/use-case/marketplace/vendor-dashboard.md): Learn about the Spree multi-vendor marketplace vendor UX. - [Multi-Store Admin Capabilities](https://spreecommerce.org/docs/use-case/multi-store/admin-capabilities.md): Learn about the admin features available in Spree Commerce multi-store. - [Multi-Store Capabilities](https://spreecommerce.org/docs/use-case/multi-store/capabilities.md): Learn about the multi-store features available in Spree Commerce. - [Multi-Store Model](https://spreecommerce.org/docs/use-case/multi-store/model.md): Learn how Spree supports the multi-store ecommerce model. - [Franchises & Reseller Networks](https://spreecommerce.org/docs/use-case/multi-tenant/franchises-and-reseller-networks.md): Learn how franchises and reseller networks can leverage a multi-tenant architecture. - [Multi-Brand Enterprises](https://spreecommerce.org/docs/use-case/multi-tenant/multi-brand-enterprise-model.md): Learn how multi-brand enterprises can leverage a multi-tenant architecture. - [Multi-Tenant Capabilities](https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-capabilities.md): Learn how Spree Enterprise Edition supports multi-tenant ecommerce use cases. - [Multi-Tenant Model](https://spreecommerce.org/docs/use-case/multi-tenant/multi-tenant-model.md): Learn about the multi-tenant ecommerce model. - [Super Admin Capabilities](https://spreecommerce.org/docs/use-case/multi-tenant/super-admin-capabilities.md): Learn how super admins can manage multi-tenant platforms in Spree Enterprise Edition. - [Tenant Capabilities](https://spreecommerce.org/docs/use-case/multi-tenant/tenant-capabilities.md): Learn how tenants can manage their stores in Spree Enterprise Edition. - [White-Label SaaS Platforms](https://spreecommerce.org/docs/use-case/multi-tenant/white-label-saas.md): Learn how to build white-label SaaS platforms with Spree Enterprise Edition. - [Spree Commerce Use Cases](https://spreecommerce.org/docs/use-case/overview.md): Launch marketplaces, SaaS, and B2B platforms faster with Spree. - [Issue Store Credits](https://spreecommerce.org/docs/user/customers/assign-store-credits.md): Learn how to issue store credits to customers in the Spree admin dashboard. - [Create a Customer](https://spreecommerce.org/docs/user/customers/create-customer.md): Learn how to create new customers in Spree Commerce as an admin. - [Customer Groups](https://spreecommerce.org/docs/user/customers/customer-groups.md): Learn to how to set up customer groups in Spree Commerce. - [Customer Profiles](https://spreecommerce.org/docs/user/customers/customer-profile.md): Learn how to access and interpret the Customer Profile in the Spree admin dashboard. - [Editing Customers](https://spreecommerce.org/docs/user/customers/edit-customer.md): Learn how to edit customer profiles in the Spree Commerce admin dashboard. - [Export Customers](https://spreecommerce.org/docs/user/customers/exporting-customers.md): Learn how to export customers records to CSV in Spree Commerce. - [Issue a Gift Card](https://spreecommerce.org/docs/user/customers/issue-gift-card.md): Learn how to issue gift cards to customers in the Spree admin dashboard. - [Searching Customers](https://spreecommerce.org/docs/user/customers/searching-customers.md): Learn how to search for customers in the Spree admin dashboard. - [Set Up Multi-Currency Pricing](https://spreecommerce.org/docs/user/how-to/multi-currency-pricing.md): Learn how to configure your store to display and sell in multiple currencies. - [Set Up Multi-Region Pricing](https://spreecommerce.org/docs/user/how-to/multi-region-pricing.md): Learn how to charge different prices within the same currency across multiple regional markets. - [Set Up Regional Volume Pricing](https://spreecommerce.org/docs/user/how-to/regional-volume.md): Learn how to offer market-specific volume discounts across multiple regions using Price Lists in Spree Commerce. - [Set Up Regional Wholesale Pricing](https://spreecommerce.org/docs/user/how-to/regional-wholesale.md): Learn how to offer market-specific wholesale pricing to trade customers across multiple regions. - [Set Up Volume Pricing](https://spreecommerce.org/docs/user/how-to/volume-pricing.md): Learn how to offer tiered discounts based on order quantity using Price Lists in Spree Commerce. - [Set Up Wholesale Pricing](https://spreecommerce.org/docs/user/how-to/wholesale-pricing.md): Learn how to offer wholesale pricing to specific customer groups using Price Lists in Spree Commerce. - [Bulk Product Operations](https://spreecommerce.org/docs/user/manage-products/bulk-product-operations.md): Learn how to perform bulk product operations in Spree Commerce. - [Export Products](https://spreecommerce.org/docs/user/manage-products/export-products.md): Learn how to export your product catalog in Spree Commerce. - [Import Products](https://spreecommerce.org/docs/user/manage-products/import-products.md): How to import products files in the Spree Commerce dashboard. - [Multi-Currency Import/Export](https://spreecommerce.org/docs/user/manage-products/multi-currency-import-export.md): Learn how to import and export product prices across multiple currencies in Spree Commerce. - [Price Lists](https://spreecommerce.org/docs/user/manage-products/price-lists.md): Learn how to set up volume pricing, user-specific pricing, and more in Spree Commerce. - [Import File Template](https://spreecommerce.org/docs/user/manage-products/product-import-file-template.md): Download a product import file template for Spree Commerce open-source - [Product Metafields](https://spreecommerce.org/docs/user/manage-products/product-metafields.md): Learn how to use product metafields in Spree Commerce to enrich your product data. - [Product Options](https://spreecommerce.org/docs/user/manage-products/product-options.md): How to manage product options in the Spree Commerce open-source dashboard - [Taxonomies](https://spreecommerce.org/docs/user/manage-products/product-taxonomies.md): Learn how to create and manage product taxonomies in the Spree Commerce dashboard. - [Searching Products](https://spreecommerce.org/docs/user/manage-products/search-products.md): Learn how to search for products in the Spree Commerce dashboard. - [Stock Levels](https://spreecommerce.org/docs/user/manage-products/stock-levels.md): Learn how to manage stock levels in Spree Commerce. - [Stock Transfers](https://spreecommerce.org/docs/user/manage-products/stock-transfers.md): Learn how to create stock transfers in the Spree Commerce. - [Translations](https://spreecommerce.org/docs/user/manage-products/translations.md): Learn how to manage and track product translations across all your store's locales in Spree Commerce. - [Migrate from Shopify](https://spreecommerce.org/docs/user/migration/migrate-from-shopify.md): Step-by-step guide to migrating your products and customers from Shopify to Spree Commerce using CSV imports - [Cancelling Orders](https://spreecommerce.org/docs/user/orders/cancelling-orders.md): Learn how to cancel orders in Spree Commerce. - [Creating Orders](https://spreecommerce.org/docs/user/orders/creating-orders.md): Learn how to manually create orders as an admin in Spree Commerce. - [Editing Orders](https://spreecommerce.org/docs/user/orders/editing-orders.md): Learn how to edit existing orders in Spree Commerce. - [Export Orders](https://spreecommerce.org/docs/user/orders/exporting-orders.md): Learn how to export orders to CSV in Spree Commerce. - [Order Adjustments](https://spreecommerce.org/docs/user/orders/order-adjustments.md): Learn how to create and settle order adjustments in Spree Commerce. - [Order States](https://spreecommerce.org/docs/user/orders/order-states.md): Learn how to use order states to track and manage orders in Spree Commerce. - [Processing Orders](https://spreecommerce.org/docs/user/orders/processing-orders.md): Learn how to process orders in the Spree Commerce admin dashboard, - [Refunding Orders](https://spreecommerce.org/docs/user/orders/refunding-orders.md): Learn how to refund orders in Spree Commerce. - [Searching Orders](https://spreecommerce.org/docs/user/orders/searching-orders.md): Learn how to search and filter orders in Spree Commerce. - [Clone a Product](https://spreecommerce.org/docs/user/products/cloning-products.md): Learn how to clone a product in Spree Commerce. - [Create a Product](https://spreecommerce.org/docs/user/products/creating-products.md): Learn how to create a new product from scratch in Spree Commerce. - [Delete a Product](https://spreecommerce.org/docs/user/products/deleting-products.md): Learn how to delete a product in Spree Commerce. - [Edit a Multi-Variant Product](https://spreecommerce.org/docs/user/products/editing-multi-variant-products.md): Learn how to edit a multi-variant product in Spree Commerce. - [Edit a Product](https://spreecommerce.org/docs/user/products/editing-products.md): Learn how to edit a product in Spree Commerce. - [Create a Promotion](https://spreecommerce.org/docs/user/promotions/create-a-promotion.md): Learn to how to create and configure promotions in Spree Commerce. - [Gift Cards](https://spreecommerce.org/docs/user/promotions/gift-cards.md): Learn how to create individual or bulk gift cards in Spree Commerce. - [Promotion Actions](https://spreecommerce.org/docs/user/promotions/promotion-actions.md): Learn how to use promotion actions in Spree Commerce. - [Promotion Rules](https://spreecommerce.org/docs/user/promotions/promotion-rules.md): Learn how to use promotion rules in Spree Commerce. - [Returns Processing](https://spreecommerce.org/docs/user/returns/returns-processing.md): Learn how to process returns in Spree Commerce. - [Enterprise Edition Security Overview](https://spreecommerce.org/docs/user/security.md): Learn how Spree Enterprise is built to meet the highest standards of data protection and risk management. - [Domains](https://spreecommerce.org/docs/user/settings/domains.md): Learn how to connect custom domains to your Spree store. - [Emails](https://spreecommerce.org/docs/user/settings/emails.md): Configure how your store communicates with customers via email. - [Stock Locations](https://spreecommerce.org/docs/user/settings/locations.md): Learn how to create and manage stock locations in Spree Commerce. - [Markets](https://spreecommerce.org/docs/user/settings/markets.md): Learn how to create and manage markets in Spree Commerce. - [Metafield Definitions](https://spreecommerce.org/docs/user/settings/metafields.md): Learn how to define and use metafields in Spree Commerce - [Payments](https://spreecommerce.org/docs/user/settings/payments.md): Learn how to view, add, edit, and remove payment methods in Spree. - [Policies](https://spreecommerce.org/docs/user/settings/policies.md): Learn how to set up and manage store policies in Spree Commerce. - [Returns Configuration](https://spreecommerce.org/docs/user/settings/returns-configuration.md): Learn how to define return authorization reasons, refund reasons, and reimbursement types. - [Shipping Methods](https://spreecommerce.org/docs/user/settings/shipping-methods.md): Learn how to set up shipping methods in Spree Commerce. - [Store Details](https://spreecommerce.org/docs/user/settings/store-details.md): Learn how to configure your store's core settings in Spree Commerce. - [Tax](https://spreecommerce.org/docs/user/settings/tax.md): Learn how to configure tax rates and categories for your Spree store. - [Users](https://spreecommerce.org/docs/user/settings/users.md): Learn how to invite and manage admin users. - [Zones](https://spreecommerce.org/docs/user/settings/zones.md): In this Spree user doc, you’ll learn how to create, edit and delete zones. - [User Quickstart](https://spreecommerce.org/docs/user/user-quickstart-guide.md): Start selling with the Spree Commerce open-source eCommerce solution - [Using Spree Commerce](https://spreecommerce.org/docs/user/using-spree.md): How do I start using Spree for my project? Should I pick the free open-source Community Edition? What is the pricing for the Enterprise Edition? - [Invite a Vendor](https://spreecommerce.org/docs/user/vendors/invite-vendor.md): In this Spree user doc, you'll learn how to invite a vendor to your multivendor marketplace. - [Vendor Onboarding](https://spreecommerce.org/docs/user/vendors/vendor-onboarding.md): In this Spree user doc, you'll learn how to onboard as a vendor to a multivendor marketplace. - [What is Spree Commerce](https://spreecommerce.org/docs/user/what-is-spree-commerce.md): What is Spree Commerce? What can I build with Spree? ## OpenAPI Specs - [store](https://spreecommerce.org/docs/api-reference/store.yaml) - [storefront](https://spreecommerce.org/docs/api-reference/storefront.yaml) - [oauth](https://spreecommerce.org/docs/api-reference/oauth.yml) - [platform](https://spreecommerce.org/docs/api-reference/platform.yaml) - [storefront_api](https://spreecommerce.org/docs/storefront_api.yml) - [openapi](https://spreecommerce.org/docs/api-reference/openapi.json)