# Spree Commerce documentation: v6.x

## v6.x

- [v6.x / Documentation (181 pages)](https://spreecommerce.org/docs/_llms/v6-x/documentation.txt): Documentation for v6.x / Documentation.
- [v6.x / API Reference (766 pages)](https://spreecommerce.org/docs/_llms/v6-x/api-reference.txt): Documentation for v6.x / API Reference.

### User Guide

#### Manage

##### Introduction

- [What is Spree Commerce](https://spreecommerce.org/docs/user/what-is-spree-commerce.md): What is Spree Commerce? What can I build with Spree?
- [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?
- [User Quickstart](https://spreecommerce.org/docs/user/user-quickstart-guide.md): Launch a Spree Commerce store fast: configure payments and taxes, add products, set a support email, and complete the Getting Started onboarding checklist.

##### Products

- [Products](https://spreecommerce.org/docs/user/products/products.md): Learn how to review your catalog, control which products are on sale, change many products at once and export them in Spree Commerce.
- [Adding Products](https://spreecommerce.org/docs/user/products/adding-products.md): Learn how to add a product to your store, with its variants, prices, stock and media, in Spree Commerce.
- [Variants](https://spreecommerce.org/docs/user/products/variants.md): Learn how to sell one product in several sizes or colors in Spree Commerce.
- [Options](https://spreecommerce.org/docs/user/products/options.md): Learn how to set up the choices, such as size or color, that turn one product into variants in Spree Commerce.
- [Media](https://spreecommerce.org/docs/user/products/media.md): Learn how to manage your store's images and videos in Spree Commerce.
- [Categories](https://spreecommerce.org/docs/user/products/categories.md): Learn how to organize your products into the tree customers browse in Spree Commerce.
- [Collections](https://spreecommerce.org/docs/user/products/collections.md): Learn how to group products by hand or by rule in Spree Commerce.
- [Custom Product Fields](https://spreecommerce.org/docs/user/products/custom-product-fields.md): Learn how to use custom product fields in Spree Commerce to enrich your product data.
- [Import & Export](https://spreecommerce.org/docs/user/products/import-and-export.md): Learn how to bring products into your store from a spreadsheet, and take them out again, in Spree Commerce.
- [Import Template](https://spreecommerce.org/docs/user/products/import-template.md): Learn how to fill in the product import file template in Spree Commerce.

##### Inventory

- [Inventory](https://spreecommerce.org/docs/user/inventory/stock-levels.md): Learn how to read your stock figures, correct a count, and bring new stock in, in Spree Commerce.
- [Stock Transfers](https://spreecommerce.org/docs/user/inventory/stock-transfers.md): Learn how to move stock between your own warehouses in Spree Commerce.
- [Purchase Orders](https://spreecommerce.org/docs/user/inventory/purchase-orders.md): Learn how to order stock from a supplier, track what is on its way, and receive it into a warehouse.
- [Suppliers](https://spreecommerce.org/docs/user/inventory/suppliers.md): Learn how to keep a record of who you buy stock from in Spree Commerce.

##### Pricing

- [Price Lists](https://spreecommerce.org/docs/user/pricing/price-lists.md): Learn how to set up volume pricing, user-specific pricing, and more in Spree Commerce.

##### Catalogs

- [Catalogs](https://spreecommerce.org/docs/user/catalogs/catalogs.md): Give a company or customer group its own product range, prices and order terms.

##### Translations

- [Translations](https://spreecommerce.org/docs/user/translations/translations.md): Learn how to manage and track product translations across all your store's locales in Spree Commerce.

##### Orders

- [Orders](https://spreecommerce.org/docs/user/orders/orders.md): Learn how to find an order, read its status and export your orders in Spree Commerce.
- [Processing Orders](https://spreecommerce.org/docs/user/orders/processing-orders.md): Learn how to fulfill an order, take its payment, change what was bought and cancel a sale in Spree Commerce.
- [Draft Orders](https://spreecommerce.org/docs/user/orders/draft-orders.md): Learn how to build an order for a customer and place it on their behalf in Spree Commerce.
- [Returns](https://spreecommerce.org/docs/user/orders/returns.md): Learn how to take goods back from a customer and refund them in Spree Commerce.
- [Exchanges](https://spreecommerce.org/docs/user/orders/exchanges.md): Learn how to swap an item a customer has bought for a different size, color or product in Spree Commerce.
- [Claims](https://spreecommerce.org/docs/user/orders/claims.md): Learn how to record a delivery that went wrong and settle it with a refund or a replacement in Spree Commerce.

##### Customers

- [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 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.
- [Searching Customers](https://spreecommerce.org/docs/user/customers/searching-customers.md): Learn how to search for customers in the Spree admin dashboard.
- [Export Customers](https://spreecommerce.org/docs/user/customers/exporting-customers.md): Learn how to export customers records to CSV in Spree Commerce.
- [Segment shoppers with Customer Groups](https://spreecommerce.org/docs/user/customers/customer-groups.md): Create Customer Groups in Spree to segment shoppers and tailor pricing, promotions, tax rules, and access for B2B accounts, VIPs, or wholesale buyers.
- [Companies](https://spreecommerce.org/docs/user/customers/companies.md): Set up business customers as organizations — with members, delivery sites, tax registrations and their own pricing.

##### Sellers

- [Sellers](https://spreecommerce.org/docs/user/sellers/sellers.md): Run a marketplace — other businesses list on your store, ship their own orders, and get paid their share.
- [Onboarding](https://spreecommerce.org/docs/user/sellers/onboarding.md): Invite a seller, set the checklist they complete before they can sell, and approve them when it is done.
- [Managing Sellers](https://spreecommerce.org/docs/user/sellers/managing-sellers.md): The sellers list, a seller's page, and what you can do from it — suspend, reinstate, edit on their behalf, and see what they are owed.
- [Seller Products](https://spreecommerce.org/docs/user/sellers/products.md): Sellers list their own products and submit them; you review each one before it goes on sale.
- [Marketplace Orders](https://spreecommerce.org/docs/user/sellers/orders.md): One checkout across several sellers becomes one order per seller — paid once, shipped separately, settled separately.
- [Commission Rates](https://spreecommerce.org/docs/user/sellers/commission-rates.md): What the marketplace charges on each sale — set as rates with rules, applied in list order, and frozen onto every sale.
- [Payouts](https://spreecommerce.org/docs/user/sellers/payouts.md): What each seller has earned, what they are owed, and how it reaches them — by hand, or through Stripe Connect.

##### Loyalty

- [Gift Cards](https://spreecommerce.org/docs/user/loyalty/gift-cards.md): Learn how to issue gift cards, follow their balances and redeem them on orders in Spree Commerce.
- [Store Credits](https://spreecommerce.org/docs/user/loyalty/store-credits.md): Learn how to give a customer store credit, track what your store owes, and edit or remove a balance in Spree Commerce.

##### Promotions

- [Create a Promotion](https://spreecommerce.org/docs/user/promotions/create-a-promotion.md): Learn to how to create and configure promotions in Spree Commerce.
- [Promotion Rules](https://spreecommerce.org/docs/user/promotions/promotion-rules.md): Learn how to use promotion rules in Spree Commerce.
- [Promotion Actions](https://spreecommerce.org/docs/user/promotions/promotion-actions.md): Learn how to use promotion actions in Spree Commerce.

##### Reports

- [Reports](https://spreecommerce.org/docs/user/reports/reports.md): Answer questions about sales, payments and stock with saved reports you can group, filter, compare and export.

##### Settings

###### Store

- [Store Details](https://spreecommerce.org/docs/user/settings/store-details.md): Learn how to configure your store's name, formats, checkout access, order numbering, stock handling and catalog defaults in Spree Commerce.
- [Emails](https://spreecommerce.org/docs/user/settings/emails.md): Learn how to set the addresses your store's transactional emails come from, brand them with your colors and font, and edit what they say.
- [Policies](https://spreecommerce.org/docs/user/settings/policies.md): Learn how to write and publish your store's terms, privacy, returns and shipping policies in Spree Commerce.
- [Sales Channels](https://spreecommerce.org/docs/user/settings/sales-channels.md): Create and manage sales channels in Spree to run multiple storefronts, B2B portals, POS, and mobile apps with per-channel catalogs and order attribution.
- [Custom Fields](https://spreecommerce.org/docs/user/settings/custom-fields.md): Learn how to add your own fields to products, orders, customers and other records in Spree Commerce, without writing any code.
- [Integrations](https://spreecommerce.org/docs/user/settings/integrations.md): Connect the external services your providers need — carriers, tax engines, and more — with credentials stored once per store.

###### Selling

- [Markets](https://spreecommerce.org/docs/user/settings/markets.md): Learn how to define the regions you sell to in Spree Commerce, each with its own currency, languages and tax treatment.
- [Payment Methods](https://spreecommerce.org/docs/user/settings/payments.md): Learn how to set up the ways customers can pay in Spree Commerce, and control when their money is taken.
- [Tax Categories](https://spreecommerce.org/docs/user/settings/tax-categories.md): Learn how to group products by tax treatment in Spree Commerce, so the right rate applies to the right goods.
- [Tax Rates](https://spreecommerce.org/docs/user/settings/tax-rates.md): Learn how to set the tax charged on each category of goods, in each place you sell, in Spree Commerce.

###### Shipping & delivery

- [Delivery Profiles](https://spreecommerce.org/docs/user/settings/delivery-profiles.md): Learn how to set up delivery profiles in Spree Commerce, the origins, zones and delivery methods that decide what a customer is offered at checkout.
- [Stock Locations](https://spreecommerce.org/docs/user/settings/locations.md): Learn how to set up the warehouses, shops and pickup points your store holds stock in and fulfils orders from.
- [Package Types](https://spreecommerce.org/docs/user/settings/package-types.md): Learn how to define the boxes, cartons, pallets and containers your store packs goods into, and how cartons set the case quantities behind bulk orders.
- [Product Types](https://spreecommerce.org/docs/user/settings/product-types.md): Learn how to use product types in Spree Commerce to pre-fill new products and control how they can be delivered.
- [Returns & Reasons](https://spreecommerce.org/docs/user/settings/returns-and-reasons.md): Learn how to set up the reasons your team picks from when handling returns, claims, refunds and cancellations in Spree Commerce.

###### Marketplace

- [Marketplace](https://spreecommerce.org/docs/user/settings/marketplace.md): Who pays your sellers and how often, whether new sellers and their products are reviewed, and the tax on your commission.
- [Seller Requirements](https://spreecommerce.org/docs/user/settings/seller-requirements.md): Build the checklist sellers complete before they can be approved to sell on your marketplace.

###### Users & permissions

- [Staff](https://spreecommerce.org/docs/user/settings/staff.md): Learn how to invite teammates to your Spree dashboard, assign their roles, and remove access when someone leaves.
- [Roles](https://spreecommerce.org/docs/user/settings/roles.md): Learn how to define what each staff role can see and do in Spree Commerce, using the permission grid.

###### Developer

- [API Keys](https://spreecommerce.org/docs/user/settings/api-keys.md): Authorise storefronts, apps and integrations to call your store's API — and scope each key to exactly what it needs.
- [Webhooks](https://spreecommerce.org/docs/user/settings/webhooks.md): Have your store notify your other systems the moment something happens — an order placed, a product updated, a return received.
- [Allowed Origins](https://spreecommerce.org/docs/user/settings/allowed-origins.md): The web addresses allowed to call your store's API from a browser — needed when your storefront or dashboard runs on its own domain.
- [Imports](https://spreecommerce.org/docs/user/settings/imports.md): Review the history of CSV files you have uploaded to Spree and how each import went.

##### How-to Guides

- [Sell to Businesses](https://spreecommerce.org/docs/user/how-to/selling-to-businesses.md): Set up a wholesale or trade customer end to end — the company, its buyers, and the catalog that decides what they see and pay.
- [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 Multiple Languages](https://spreecommerce.org/docs/user/how-to/multiple-languages.md): Learn how to sell in multiple languages by configuring locales, translating products, categories, and policies in Spree Commerce.
- [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 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 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.
- [Schedule a Sale](https://spreecommerce.org/docs/user/how-to/schedule-sale-pricing.md): Learn how to use Price Lists to schedule time-limited sale pricing across your catalog, including market-specific discounts.

##### Migration

- [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

##### Security

- [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.

### Changelog

- [Changelog](https://spreecommerce.org/docs/changelog.md): Keep up with the latest features and improvements in Spree Commerce!

## OpenAPI Specs

- [store](/docs/api-reference/store.yaml)
- [admin](/docs/api-reference/admin.yaml)
- [seller](/docs/api-reference/seller.yaml)