Spree Commerce

Overview of Violet's Spree Commerce integration for channel developers

Spree Commerce is an open-source Ruby on Rails ecommerce framework with a JSON:API-style REST API. Violet integrates using OAuth2 client credentials.

Connection

Merchants provide a Client ID and Client Secret from an OAuth application configured in their Spree store. The OAuth application must be created with the admin write scope.

Merchants also provide their Store URL — the base URL of their Spree instance.

Webhooks

Webhooks are registered automatically via the Spree API after a merchant connects. Violet listens for order and product lifecycle events. All Violet-originated orders are tagged with channel = "Violet" so that event processing can correctly identify Violet-placed orders.

API Format

Spree responses follow JSON:API conventions, using included arrays for related resources. Violet handles this format transparently.

Notable Behavior

• Discounts: Discount codes are not supported for Violet-submitted orders on Spree. Custom discount amounts are also not supported at this time.

• Checkout flow: Spree uses an explicit multi-step checkout flow. Violet manages this flow internally during order submission.

• Product data: Spree uses taxons for product categorization.

---

Looking for Vendo? Vendo is a hosted variant of Spree with a near-identical integration. See the Vendo page for any differences.