Spree Commerce integration
Spree Commerce is an open-source Rails commerce platform; this is its Admin API v3, the back-office REST surface of a self-hosted store. Manage the catalog (products with bulk tag, category, collection, channel and status operations, variants, option types, categories and collections including product membership and merchandising order, media uploads), sales (orders end to end: line items, discounts, fees, gift cards and store credit applied to an order, approve, complete, cancel, resume, confirmation resend; fulfillments with fulfil, split, cancel, resume, mark delivered and shipping-label purchase; payments with capture and void; refunds), customers (records, tags, addresses, store credits, customer groups and bulk group membership), promotions with their rules, actions and coupon codes, pricing (price lists with activation, prices with bulk upsert and bulk delete), inventory stock locations, and store settings including tax rates. The host is part of the credential because every install is its own deployment. Authentication is a secret admin API key sent as the x-spree-api-key header, or a JWT bearer token.
Say what should happen.
The workflow builds itself.
What you can do with Spree Commerce
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
Product, 8 operations
add_product_to_categoryAdd product to categoryPOSTAdd a product to a category.add_product_to_collectionAdd product to collectionPOSTAdd a product to a collection.create_productCreate productPOSTCreate a product.delete_productDelete productDELETEDelete a product.get_productGet productGETGet a product.list_category_productsList category productsGETList category products.list_collection_productsList collection productsGETList collection products.list_productsList productsGETList products.
Categorie, 4 operations
create_categoryCreate categoryPOSTCreate a category.delete_categoryDelete categoryDELETEDelete a category.get_categoryGet categoryGETGet a category.list_categoriesList categoriesGETList categories.
Collection, 4 operations
create_collectionCreate collectionPOSTCreate a collection.delete_collectionDelete collectionDELETEDelete a collection.get_collectionGet collectionGETGet a collection.list_collectionsList collectionsGETList collections.
Customer, 4 operations
create_customerCreate customerPOSTCreate a customer.delete_customerDelete customerDELETEDelete a customer.get_customerGet customerGETShow a customer.list_customersList customersGETList customers.
Customer group, 4 operations
create_customer_groupCreate customer groupPOSTCreate a customer group.delete_customer_groupDelete customer groupDELETEDelete a customer group.get_customer_groupGet customer groupGETGet a customer group.list_customer_groupsList customer groupsGETList customer groups.
Item, 4 operations
add_order_itemAdd order itemPOSTAdd an item.get_order_itemGet order itemGETShow an item.list_order_itemsList order itemsGETList order items.remove_order_itemRemove order itemDELETERemove an item.
Option type, 4 operations
create_option_typeCreate option typePOSTCreate an option type.delete_option_typeDelete option typeDELETEDelete an option type.get_option_typeGet option typeGETGet an option type.list_option_typesList option typesGETList option types.
Order, 4 operations
create_orderCreate orderPOSTCreate a draft order.delete_orderDelete orderDELETEDelete a draft order.get_orderGet orderGETShow an order.list_ordersList ordersGETList orders.
Price, 4 operations
create_priceCreate pricePOSTCreate a price.delete_priceDelete priceDELETEDelete a price.get_priceGet priceGETGet a price.list_pricesList pricesGETList prices.
Price list, 4 operations
create_price_listCreate price listPOSTCreate a price list.delete_price_listDelete price listDELETEDelete a price list.get_price_listGet price listGETGet a price list.list_price_listsList price listsGETList price lists.
Promotion, 4 operations
create_promotionCreate promotionPOSTCreate a promotion.delete_promotionDelete promotionDELETEDelete a promotion.get_promotionGet promotionGETShow a promotion.list_promotionsList promotionsGETList promotions.
Stock location, 4 operations
create_stock_locationCreate stock locationPOSTCreate a stock location.delete_stock_locationDelete stock locationDELETEDelete a stock location.get_stock_locationGet stock locationGETGet a stock location.list_stock_locationsList stock locationsGETList stock locations.
Store credit, 4 operations
add_order_store_creditAdd order store creditPOSTApply customer's store credit to an order.create_customer_store_creditCreate customer store creditPOSTIssue a store credit to a customer.delete_customer_store_creditDelete customer store creditDELETEDelete a store credit.list_customer_store_creditsList customer store creditsGETList customer store credits.
Tax rate, 4 operations
create_tax_rateCreate tax ratePOSTCreate a tax rate.delete_tax_rateDelete tax rateDELETEDelete a tax rate.get_tax_rateGet tax rateGETGet a tax rate.list_tax_ratesList tax ratesGETList tax rates.
Variant, 4 operations
create_variantCreate variantPOSTCreate a variant.delete_variantDelete variantDELETEDelete a variant.get_variantGet variantGETGet a variant.list_variantsList variantsGETList product variants.
Addresse, 3 operations
create_customer_addressCreate customer addressPOSTCreate a customer address.delete_customer_addressDelete customer addressDELETEDelete a customer address.list_customer_addressesList customer addressesGETList customer addresses.
Fulfillment, 3 operations
create_fulfillmentCreate fulfillmentPOSTCreate a fulfillment.get_fulfillmentGet fulfillmentGETShow a shipment.list_fulfillmentsList fulfillmentsGETList fulfillments.
Media, 3 operations
attach_product_mediaAttach product mediaPOSTPlace a library file on a product.create_mediaCreate mediaPOSTUpload a file to the library.list_mediaList mediaGETList media.
Payment, 3 operations
create_order_paymentCreate order paymentPOSTCreate a payment.get_order_paymentGet order paymentGETShow a payment.list_order_paymentsList order paymentsGETList payments.
Promotion action, 3 operations
create_promotion_actionCreate promotion actionPOSTCreate an action on a promotion.delete_promotion_actionDelete promotion actionDELETEDelete an action from a promotion.list_promotion_actionsList promotion actionsGETList actions for a promotion.
Promotion rule, 3 operations
create_promotion_ruleCreate promotion rulePOSTCreate a rule on a promotion.delete_promotion_ruleDelete promotion ruleDELETEDelete a rule from a promotion.list_promotion_rulesList promotion rulesGETList rules for a promotion.
Bulk add tag, 2 operations
bulk_add_customer_tagsBulk add customer tagsPOSTBulk-add tags to customers.bulk_add_product_tagsBulk add product tagsPOSTBulk-add tags to products.
Bulk destroy, 2 operations
bulk_delete_pricesBulk delete pricesDELETEBulk-delete prices.bulk_delete_productsBulk delete productsDELETEBulk-delete products.
Bulk remove tag, 2 operations
bulk_remove_customer_tagsBulk remove customer tagsPOSTBulk-remove tags from customers.bulk_remove_product_tagsBulk remove product tagsPOSTBulk-remove tags from products.
Cancel, 2 operations
cancel_fulfillmentCancel fulfillmentPATCHCancel a fulfillment.cancel_orderCancel orderPATCHCancel an order.
Discount, 2 operations
add_order_discountAdd order discountPOSTCreate manual discount.list_order_discountsList order discountsGETList discounts.
Gift card, 2 operations
add_order_gift_cardAdd order gift cardPOSTApply a gift card to an order.remove_order_gift_cardRemove order gift cardDELETERemove a gift card from an order.
Payment method, 2 operations
get_payment_methodGet payment methodGETShow a payment method.list_payment_methodsList payment methodsGETList payment methods.
Refund, 2 operations
create_order_refundCreate order refundPOSTCreate a refund.list_order_refundsList order refundsGETList refunds.
Activate, 1 operation
activate_price_listActivate price listPATCHActivate a price list.
Approve, 1 operation
approve_orderApprove orderPATCHApprove an order.
Bulk add to categorie, 1 operation
bulk_add_products_to_categoriesBulk add products to categoriesPOSTBulk-add products to categories.
Bulk add to channel, 1 operation
bulk_add_products_to_channelsBulk add products to channelsPOSTBulk-add products to channels.
Bulk add to collection, 1 operation
bulk_add_products_to_collectionsBulk add products to collectionsPOSTBulk-add products to collections.
Bulk add to group, 1 operation
bulk_add_customers_to_groupsBulk add customers to groupsPOSTBulk-add customers to groups.
Bulk remove from categorie, 1 operation
bulk_remove_products_from_categoriesBulk remove products from categoriesPOSTBulk-remove products from categories.
Bulk remove from channel, 1 operation
bulk_remove_products_from_channelsBulk remove products from channelsPOSTBulk-remove products from channels.
Bulk remove from collection, 1 operation
bulk_remove_products_from_collectionsBulk remove products from collectionsPOSTBulk-remove products from collections.
Bulk remove from group, 1 operation
bulk_remove_customers_from_groupsBulk remove customers from groupsPOSTBulk-remove customers from groups.
Bulk status update, 1 operation
bulk_update_product_statusBulk update product statusPOSTBulk-update product status.
Bulk upsert, 1 operation
bulk_upsert_pricesBulk upsert pricesPOSTBulk-upsert prices.
Capture, 1 operation
capture_paymentCapture paymentPATCHCapture a payment.
Complete, 1 operation
complete_orderComplete orderPATCHComplete an order.
Coupon code, 1 operation
list_coupon_codesList coupon codesGETList coupon codes for a promotion.
Deactivate, 1 operation
deactivate_price_listDeactivate price listPATCHDeactivate a price list.
Fee, 1 operation
add_order_feeAdd order feePOSTCreate fee.
Fulfill, 1 operation
mark_fulfillment_fulfilledMark fulfillment fulfilledPATCHFulfill a fulfillment.
Mark delivered, 1 operation
mark_fulfillment_deliveredMark fulfillment deliveredPATCHMark a fulfillment delivered.
Me, 1 operation
get_current_admin_userGet current admin userGETGet current admin user and permissions.
Purchase label, 1 operation
purchase_fulfillment_labelPurchase fulfillment labelPATCHBuy the shipping label.
Store, 1 operation
get_storeGet storeGETGet the current store.
Showing the first 120 of 150 endpoints. The rest are in the product, searchable from the workflow builder and from chat.
Use Spree Commerce from Claude Code, Cursor or Codex
Connect Spree Commerce in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Spree Commerce operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect Spree Commerce
- Create your workspace
Sign up free. Nothing to install.
- Connect Spree Commerce once
Add your Spree Commerce connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
Spree Commerce integration FAQ
What can you do with the Spree Commerce integration?
LiveContext exposes 150 operations on Spree Commerce, covering product, categorie, collection and customer.
