Spree Commerce documentation llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt) # Spree Commerce documentation llms.txt spreecommerce.org/llms.txt [Raw llms.txt](https://spreecommerce.org/docs/llms.txt) [Raw llms-full.txt](https://spreecommerce.org/llms-full.txt) Copy Markdown [](https://spreecommerce.org/llms.txt) llms.txt Docs Create an allowed origin Delete an allowed origin Get an allowed origin List allowed origins Update an allowed origin Create an API key Delete an API key Describe the current API key List API keys Revoke an API key Show an API key Update an API key Authenticate Admin API requests with keys and JWTs Get current admin user and permissions Login Logout Refresh token Request password reset Reset password Update the current admin profile Add a product to a category Create a category Delete a category Get a category List categories List category products Reposition a category Reposition a category product Update a category Create a channel Delete a channel Get a channel List channels Publish products on a channel Unpublish products from a channel Update a channel Create a custom field definition Delete a custom field definition List custom field definitions Show a custom field definition Update a custom field definition Create a customer group Delete a customer group Get a customer group List customer groups Update a customer group Bulk-add customers to groups Bulk-add tags to customers Bulk-remove customers from groups Bulk-remove tags from customers Create a customer Create a customer address Delete a customer Delete a customer address Delete a customer credit card Delete a store credit Issue a store credit to a customer List customer addresses List customer credit cards List customer store credits List customers Show a customer Show a customer credit card Update a customer Update a customer address Update a store credit Admin API endpoint index Admin API error responses, status codes, and handling Create an export Delete an export Download an export List exports Show an export Cancel a fulfillment Create a fulfillment Fulfill a fulfillment List fulfillments Resume a fulfillment Show a shipment Split a fulfillment Update a shipment Create a gift card Create a gift card batch Delete a gift card Get a gift card Get a gift card batch List gift card batches List gift cards Update a gift card Complete mapping and start processing Create an import Delete an import Download an import template Download the originally uploaded file List import rows List imports Retry failed rows Show an import Spree Admin API introduction and SDK quick start Create a market Delete a market Get a market List markets Update a market Monetary amounts in the Admin API: prices, costs, formats Create an option type Delete an option type Get an option type List option types Update an option type Add an item Apply a gift card to an order Apply customer's store credit to an order Approve an order Cancel an order Complete an order Create a draft order Delete a draft order List order items List orders Remove a gift card from an order Remove an item Remove store credit from an order Resend confirmation email Resume a canceled order Show an item Show an order Update an item Update an order List available payment provider types List payment methods Show a payment method Capture a payment Create a payment List payments Show a payment Void a payment Activate a price list Bulk-delete prices Bulk-upsert prices Create a price Create a price list Deactivate a price list Delete a price Delete a price list Get a price Get a price list List price lists List prices Update a price Update a price list Bulk-add products to categories Bulk-add products to channels Bulk-add tags to products Bulk-delete products Bulk-remove products from categories Bulk-remove products from channels Bulk-remove tags from products Bulk-update product status Create a product Create a product custom field Delete a product Delete a product custom field Get a product List product custom fields List product translations List products Show a product custom field Update a product Update a product custom field Create a promotion Create a rule on a promotion Create an action on a promotion Delete a promotion Delete a rule from a promotion Delete an action from a promotion List actions for a promotion List available promotion action types List available promotion rule types List coupon codes for a promotion List promotions List rules for a promotion Show a promotion Update a promotion Update a rule's preferences Filter, sort, paginate, and expand Admin API responses Create a refund List refunds Batch upsert translations Get a store credit category Get the current store List store credit categories List supported locales List tags List translatable resources Update the current store Create an invitation List invitations List roles List staff Remove a staff member from this store Resend an invitation Revoke an invitation Show a staff member Update a staff member Create a stock location Delete a stock location Get a stock location List stock locations Update a stock location Create a variant Delete a variant Get a variant List product variants Update a variant Create a webhook endpoint Delete a webhook endpoint Disable a webhook endpoint Get a webhook delivery Get a webhook endpoint List webhook deliveries List webhook endpoints Re-enable a webhook endpoint Redeliver a webhook delivery Send a test delivery Update a webhook endpoint Create an Address Delete an Address Return a list of Addresses Return an Address Update an Address Create an Adjustment Delete an Adjustment Return a list of Adjustments Return an Adjustment Update an Adjustment Authentication Create a Classification Delete a Classification Return a Classification Return a list of Classifications Update a Classification Create a CMS Page Delete a CMS Page Return a CMS Page Return a list of CMS Pages Update a CMS Page Create a CMS Section Delete a CMS Section Return a CMS Section Return a list of CMS Sections Update a CMS Section Returns a Country Returns a list of Countries Create a Data Feed Delete a Data Feed Return a Data Feed Return a list of Data Feeds Update a Data Feed Create a Digital Asset Delete a Digital Asset Return a Digital Asset Return a list of Digital Assets Update a Digital Asset Create a Digital Link Delete a Digital Link Reset a Digital Link Return a Digital Link Return a list of Digital Links Update a Digital Link Create a Line Item Delete a Line Item Return a Line Item Return a list of Line Items Update a Line Item Create a Menu Item Delete a Menu Item Reposition a Menu Item Return a list of Menu Items Return a Menu Item Update a Menu Item Create a Menu Delete a Menu Return a list of Menus Return a Menu Update a Menu Create an Option Type Delete an Option Type Return a list of Option Types Return an Option Type Update an Option Type Create an Option Value Delete an Option Value Return a list of Option Values Return an Option Value Update an Option Value Advances an Order Apply Coupon Code for an Order Approves an Order Cancels an Order Completes an Order Creates an Order Delete an Order Empties an Order Next an Order Return a list of Orders Return an Order Update an Order Use Store Credit for an Order Create a Payment Method Delete a Payment Method Return a list of Payment Methods Return a Payment Method Update a Payment Method Delete a Payment Return a list of Payments Return a Payment Create a Product Delete a Product Return a list of Products Return a Product Update a Product Create a Promotion Action Delete a Promotion Action Return a list of Promotion Actions Return a Promotion Action Update a Promotion Action Create a Promotion Category Delete a Promotion Category Return a list of Promotion Categories Return a Promotion Category Update a Promotion Category Create a Promotion Rule Delete a Promotion Rule Return a list of Promotion Rules Return a Promotion Rule Update a Promotion Rule Create a Promotion Delete a Promotion Return a list of Promotions Return a Promotion Update a Promotion Create a Role Delete a Role Return a list of Roles Return a Role Update a Role Adds item (Variant) to an existing Shipment Cancels the Shipment Create a Shipment Delete a Shipment Mark Shipment as ready to be shipped Mark Shipment as shipped Moves Shipment back to pending state Removes item (Variant) from Shipment Resumes the Shipment Return a list of Shipments Return a Shipment Update a Shipment Create a Shipping Category Delete a Shipping Category Return a list of Shipping Categories Return a Shipping Category Update a Shipping Category Create a Shipping Method Delete a Shipping Method Return a list of Shipping Methods Return a Shipping Method Update a Shipping Method Returns a list of States Returns a State Create a Stock Item Delete a Stock Item Return a list of Stock Items Return a Stock Item Update a Stock Item Create a Stock Location Delete a Stock Location Return a list of Stock Locations Return a Stock Location Update a Stock Location Create a Store Credit Category Delete a Store Credit Category Return a list of Store Credit Categories Return a Store Credit Category Update a Store Credit Category Create a Store Credit Type Delete a Store Credit Type Return a list of Store Credit Types Return a Store Credit Type Update a Store Credit Type Create a Store Credit Delete a Store Credit Return a list of Store Credits Return a Store Credit Update a Store Credit Create a Tax Category Delete a Tax Category Return a list of Tax Categories Return a Tax Category Update a Tax Category Create a Tax Rate Delete a Tax Rate Return a list of Tax Rates Return a Tax Rate Update a Tax Rate Create a Taxonomy Delete a Taxonomy Return a list of Taxonomies Return a Taxonomy Update a Taxonomy Create a Taxon Delete a Taxon Reposition a Taxon Return a list of Taxons Return a Taxon Update a Taxon Create a User Delete a User Return a list of Users Return a User Update a User Delete a Variant Return a list of Variants Return a Variant Approves Vendor Completes onboarding process Create a Vendor Delete a Vendor Invites Vendor to the platform Rejects Vendor Return a list of Vendors Return a Vendor Start onboarding process Suspends Vendor Update a Vendor Return a list of Webhook Events Create a Webhook Subscriber Delete a Webhook Subscriber Return a list of Webhook Subscribers Return a Webhook Subscriber Update a Webhook Subscriber Create a Wished Item Delete a Wished Item Return a list of Wished Items Return a Wished Item Update a Wished Item Create a Wishlist Delete a Wishlist Return a list of Wishlists Return a Wishlist Update a Wishlist Create a Zone Delete a Zone Return a list of Zones Return a Zone Update a Zone Authentication Login Logout Refresh token Request a password reset Reset password with token Add item to cart Apply discount code Apply gift card Apply store credit Associate guest cart with authenticated user Complete cart Complete payment session Create a new cart Create payment Create payment session Delete a cart Get a cart Get payment session List active carts Remove discount code Remove gift card Remove line item from cart Remove store credit Select delivery rate for fulfillment Update a cart Update line item quantity Update payment session Complete payment setup session Create an address Create payment setup session Delete a credit card Delete an address Get a credit card Get a gift card Get a store credit Get an address Get an order Get current customer profile Get payment setup session List customer addresses List gift cards List orders List saved credit cards List store credits Register a new customer Update an address Update current customer profile Download a digital product Errors Idempotency Store API Localization Get a country Get a country in a market Get a market List countries List countries in a market List markets List supported currencies List supported locales Resolve market by country Metadata Migrating from Storefront API v2 Monetary Amounts Subscribe to the newsletter Verify a newsletter subscription Get an order Get a policy List store policies Get a category Get a product Get product filters List categories List products Querying Rate Limiting Relations Add item to wishlist Create a wishlist Delete a wishlist Get a wishlist List wishlists Remove item from wishlist Update a wishlist Create an Address List all Addresses Remove an Address Update an Address List all Credit Cards Remove a Credit Card Retrieve the default Credit Card List all Orders Retrieve an Order Create an Account Retrieve an Account Update an Account Complete an Adyen payment session and order Create an Adyen Payment Session Get Adyen Payment Session Authentication Apply a Coupon Code / Gift Card Remove a Coupon / Gift Card Remove all Coupons Add an Item to Cart Remove a Line Item Set Line Item Quantity Associate a Cart with a User Change Cart Currency Empty the Cart List Estimated Shipping Rates Create a Cart Delete a Cart Retrieve a Cart Create new Payment List Payment Methods List Shipping Rates Selects shipping method for shipment(s) Advance Checkout Complete Checkout Next Checkout Step Add Store Credit Remove Store Credit Update Checkout Validate order payment Get Default Country List all Countries Retrieve a Country Download a Digital Asset Retrieve an Order Status List all Store Policies Retrieve a Policy List all Post Categories Retrieve a Post Category List all Posts Retrieve a Post List all Products Retrieve a Product Return the current Store Create a Stripe Payment Intent Create a Stripe Setup Intent Mark the payment intent as confirmed, and move the order to the complete state Return a Stripe Payment Intent Updates Stripe Payment Intent List all Taxons Retrieve a Taxon List all Product Variants List all Vendors Retrieve a Vendor Add Item to Wishlist Add Items to Wishlist Delete Item from Wishlist Delete Items from Wishlist Set Wished Item Quantity Create a Wishlist Delete a Wishlist List all Wishlists Retrieve a Wishlist Retrieve the default Wishlist Update a Wishlist Adyen Integration Guide for Android Adyen Integration Guide for iOS Quick Checkout with Stripe and Storefront API Fetching multiple resources Filtering and sorting Ecommerce API Pagination Webhook Events & Payloads Admin Dashboard Admin Panel Authentication Admin Components Admin Dashboard Custom CSS Custom JavaScript for Admin Dashboard Extending Admin Dashboard UI Admin Form Builder API Admin Dashboard Helper Methods Extending Admin Navigation Admin Tables Agent Skills LLM-Ready Documentation Docs MCP Server Agentic Development Call the Admin API from the CLI Spree CLI Creating a Spree extension Developing Spree Contributing quickstart Addresses Adjustments Architecture Calculators Channels Customers Events Imports & Exports Inventory Markets Media Metafields Orders Payments Pricing Products Promotions Reports Search & Filtering Shipments Slugs Staff & Roles Store Credits & Gift Cards Stores Taxes Translations Webhooks create-spree-app Customizing the Spree API Authentication Checkout Flow Configuration Decorators Dependencies Metadata Model Preferences Permissions Quickstart Routes Assets Amazon Web Services (AWS) Caching CDN Database Configuration Docker Sending out Emails Environment Variables Render Installing Spree Integrate a Third-Party Identity Provider Build Custom Order Routing Build a Custom Payment Method Build Custom Promotion Rules & Actions Build a Custom Report Build a Custom Search Provider Build a Custom Stock Splitter Spree Multi Tenant Configuration Multi-Tenant Core Concepts Create a multi-tenant / SaaS platform on top of Spree Spree Multi Vendor Installation Building a Multi-Vendor Marketplace with Spree Admin SDK authentication with API keys and JWT cookies Custom Admin Endpoints Filtering, pagination, and error handling in the Admin SDK Admin SDK quickstart for @spree/admin-sdk Admin SDK resources and CRUD client methods Authentication Configuration Custom Endpoints Spree TypeScript SDK quickstart for the Store API Customer Account Cart, Checkout & Orders Markets Payments & Delivery Products & Categories Wishlists PCI Compliance Security Policy Architecture Customization Deployment Quickstart Admin Dashboard Expose a custom model through the Store and Admin APIs Events & Webhooks Extending Core Models Tutorial Model SDK Testing 2.0 to 2.1 2.1 to 2.2 2.2 to 2.3 2.3 to 2.4 3.0 to 3.1 3.1 to 3.2 3.2 to 3.3 3.3 to 3.4 3.4 to 3.5 3.5 to 3.6 3.6 to 3.7 3.7 to 4.0 4.0 to 4.1 4.1 to 4.2 Upgrading to Spree 5.0 4.3 to 4.4 4.4 to 4.5 4.5 to 4.6 4.6 to 4.7 Upgrading to Spree 4.9 Upgrading to Spree 4.10 Upgrading to Spree 4.8 Upgrading to Spree 5.1 Upgrading to Spree 5.2 Upgrading to Spree 5.3 Upgrading to Spree 5.4 Upgrading to Spree 5.5 Quickstart Connect Google Analytics 4 to Spree Commerce Connect Google Tag Manager to Spree Commerce 3rd party integrations Connect Klaviyo email marketing platform to Spree Commerce Connect Adyen payments to Spree Commerce Connect PayPal payments to Spree Commerce Connect Razorpay payments to Spree Commerce Connect Stripe payments to Spree Commerce Meilisearch Connect Avalara AvaTax to Spree Commerce B2B Admin Capabilities B2B Buyer Experience B2B Capabilities B2B Commerce Model Digital Products Admin Capabilities Digital Products Capabilities Digital Products Model Marketplace Admin Panel Marketplace Capabilities Marketplace Customer Experience Marketplace Model Marketplace Vendor Panel Franchises & Reseller Networks Multi-Brand Enterprises Multi-Tenant Capabilities Multi-Tenant Model Super Admin Capabilities Tenant Capabilities White-Label SaaS Platforms Spree Commerce Use Cases Issue Store Credits Create a Customer Segment shoppers with Customer Groups Customer Profiles Editing Customers Export Customers Issue a Gift Card Searching Customers Set Up Multi-Currency Pricing Set Up Multi-Region Pricing Set Up Multiple Languages Set Up Regional Volume Pricing Set Up Regional Wholesale Pricing Schedule a Sale Set Up Volume Pricing Set Up Wholesale Pricing Bulk Product Operations Export Products Import Products Multi-Currency Import/Export Price Lists Import File Template Product Metafields Product Options Taxonomies Searching Products Stock Levels Stock Transfers Translations Migrate from Shopify Cancelling Orders Creating Orders Editing Orders Export Orders Order Adjustments Order States Processing Orders Refunding Orders Searching Orders Clone a Product Create a Product Delete a Product Edit a Multi-Variant Product Edit a Product Create a Promotion Gift Cards Promotion Actions Promotion Rules Returns Processing Enterprise Edition Security Overview Emails Stock Locations Marketplace Configuration Markets Metafield Definitions Payments Policies Returns Configuration Sales Channels Shipping Methods Store Details Tax Users Zones User Quickstart Using Spree Commerce Commission Rates Multi-Vendor Checkout Vendor Management Manual/CSV Vendor Onboarding Shopify Vendor Onboarding WooCommerce Vendor Onboarding Vendor Payouts What is Spree Commerce OpenAPI Specs store admin storefront oauth platform storefront_api openapi ## What is Spree Commerce documentation's llms.txt? Spree Commerce documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Spree Commerce documentation offers and where to find details. Pass Spec 2 Sections 873 Links 98.6 KB Size ~24.8k Tokens Sections: Docs · OpenAPI Specs ## Add Spree Commerce documentation Docs to Your AI Assistant Select your tool to see how to add Spree Commerce documentation's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://spreecommerce.org/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Spree Commerce documentation Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 4 notes ## Frequently Asked Questions Where is Spree Commerce documentation's llms.txt file? Spree Commerce documentation publishes its llms.txt at https://spreecommerce.org/llms.txt. This file provides a structured, markdown-formatted index of Spree Commerce documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Spree Commerce documentation's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Spree Commerce documentation's documentation so it can provide better code suggestions and answers about Spree Commerce documentation. What does Spree Commerce documentation's llms.txt contain? Spree Commerce documentation's llms.txt contains 2 sections and 873 documentation links in 98.6 KB (~24.8k tokens). Key sections include Docs, OpenAPI Specs. How many tokens does Spree Commerce documentation's llms.txt use? The concise llms.txt index is approximately 24.8k tokens (98.6 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Dynamic Documentation**Agent navigation guide:** Use the Table of Contents to identify the](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/dynamic-documentation) [Honeybadger Honeybadger provides all-in-one error tracking, uptime monitoring, logging, and application performance monitoring (Just Enough APM™) in one simple observability platform built for developers.](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/honeybadger) [Kirby CMS Docs The official Kirby CMS documentation for Kirby CMS, covering Guides, Reference, Cookbook and Quicktips.](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/kirby-cms-docs) [LogTape Unobtrusive logging
for modern JavaScript](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/logtape) [Tyk Documentation](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/tyk-documentation) [Roc A fast, friendly, functional language](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/roc-lang) [Axiom Docs](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/axiom-docs) [LoginRadius LoginRadius is an external identity and access management platform that provides secure, compliant and privacy-friendly CIAM, and IAM for B2B apps. It is a developer-first, API-driven platform trusted by mid-to-large enterprises and SaaS companies worldwide powering over 500 global brands and secures ~2B monthly active users.](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt/loginradius) [View all 99 projects ](https://mdream.dev/llms-txt/spree-commerce-documentation/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/spree-commerce-documentation/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/spree-commerce-documentation/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)