@spree/docs 0.1.35 → 0.1.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api-reference/admin-api/introduction.md +3 -0
- package/dist/api-reference/store-api/introduction.md +3 -0
- package/dist/developer/core-concepts/events.md +3 -0
- package/dist/developer/core-concepts/markets.md +3 -0
- package/dist/developer/core-concepts/media.md +3 -1
- package/dist/developer/core-concepts/pricing.md +7 -5
- package/dist/developer/core-concepts/search-filtering.md +3 -1
- package/dist/developer/core-concepts/store-credits-gift-cards.md +3 -0
- package/dist/developer/core-concepts/webhooks.md +3 -0
- package/package.json +1 -1
|
@@ -3,6 +3,9 @@ title: "Admin API"
|
|
|
3
3
|
sidebarTitle: "Introduction"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
> **WARNING:** **Developer Preview.** The Admin API is in active development and may change between major versions.
|
|
7
10
|
|
|
8
11
|
The Admin API is a REST API for managing a Spree stores programmatically — products, orders, customers, fulfillments, payments, and more. It is intended for backend integrations, custom admin tooling, and automation.
|
|
@@ -3,6 +3,9 @@ title: "Store API"
|
|
|
3
3
|
sidebarTitle: "Introduction"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
This API reference includes Spree Store APIs, which are REST APIs exposed by the Spree application. They are used to create a storefront for your commerce store, such as a website, point of sale or a commerce mobile app.
|
|
7
10
|
|
|
8
11
|
All API Routes are prefixed with `/api/v3/store`. So, during development, the API Routes will be available under the path `http://localhost:3000/api/v3/store`. For production, replace `http://localhost:3000` with your Spree application URL.
|
|
@@ -3,6 +3,9 @@ title: Events
|
|
|
3
3
|
description: Learn how Spree's event system works and how to subscribe to events.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
8
11
|
Spree includes a powerful event system that allows you to react to various actions happening in your store. When something happens (an order is completed, a product is created, etc.), Spree publishes an event that your code can subscribe to and handle.
|
|
@@ -3,6 +3,9 @@ title: Markets
|
|
|
3
3
|
description: Multi-region commerce with Markets — bundle geography, currency, and locale into distinct selling regions within a single store.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
8
11
|
Markets let you segment a single [Store](stores.md) into distinct geographic regions, each with its own currency, locale, and set of countries. For example, an international store might define:
|
|
@@ -4,6 +4,8 @@ sidebarTitle: "Media"
|
|
|
4
4
|
description: Product media (images, videos), named variants, focal points, and how media is served via the Store API
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
+
import { Since } from '/snippets/since.mdx';
|
|
8
|
+
|
|
7
9
|
## Overview
|
|
8
10
|
|
|
9
11
|
Spree handles uploads, processing, and delivery for product media. Images are automatically converted to WebP format and preprocessed into multiple sizes for optimal performance.
|
|
@@ -22,7 +24,7 @@ Each media item has a `media_type` field that defaults to `image`. The `variant_
|
|
|
22
24
|
|
|
23
25
|
> **NOTE:** `Spree::Image` is a backward-compatible subclass of `Spree::Asset` that sets `media_type` to `image`. New code should use `Spree::Asset` directly.
|
|
24
26
|
|
|
25
|
-
### Named Variant Sizes
|
|
27
|
+
### Named Variant Sizes
|
|
26
28
|
|
|
27
29
|
When an image is uploaded, Spree automatically generates optimized versions in the background:
|
|
28
30
|
|
|
@@ -3,6 +3,8 @@ title: Pricing
|
|
|
3
3
|
description: Prices, Price Lists, Price Rules, and the Pricing Context — Spree's flexible pricing engine for regional, wholesale, volume, and market-based pricing.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
6
8
|
## Overview
|
|
7
9
|
|
|
8
10
|
Spree's pricing system supports both simple single-currency pricing and advanced multi-currency, rule-based pricing through Price Lists. Every [Variant](products.md#variants) can have multiple prices — a base price per currency, plus additional prices from Price Lists that apply conditionally based on rules like geography, customer segment, or quantity.
|
|
@@ -51,7 +53,7 @@ curl 'https://api.mystore.com/api/v3/store/products/spree-tote?expand=variants'
|
|
|
51
53
|
```
|
|
52
54
|
|
|
53
55
|
|
|
54
|
-
## Price Lists
|
|
56
|
+
## Price Lists
|
|
55
57
|
|
|
56
58
|
Price Lists allow you to create different pricing strategies based on various conditions. This enables advanced pricing scenarios like:
|
|
57
59
|
|
|
@@ -84,7 +86,7 @@ If no applicable Price List is found, the base price is used.
|
|
|
84
86
|
| `match_policy` | How rules are evaluated: `all` (every rule must match) or `any` (at least one) |
|
|
85
87
|
| `position` | Priority order (lower numbers = higher priority) |
|
|
86
88
|
|
|
87
|
-
## Price Rules
|
|
89
|
+
## Price Rules
|
|
88
90
|
|
|
89
91
|
Price Rules define conditions that must be met for a Price List to apply. Spree includes five built-in rule types:
|
|
90
92
|
|
|
@@ -96,7 +98,7 @@ Price Rules define conditions that must be met for a Price List to apply. Spree
|
|
|
96
98
|
| **Customer Group Rule** | Matches members of customer groups | Loyalty tiers, membership pricing |
|
|
97
99
|
| **Volume Rule** | Matches based on quantity purchased | Bulk discounts, tiered pricing |
|
|
98
100
|
|
|
99
|
-
### Market Rule
|
|
101
|
+
### Market Rule
|
|
100
102
|
|
|
101
103
|
The recommended approach for regional pricing when using Markets. Applies the Price List when the customer is in one of the specified markets.
|
|
102
104
|
|
|
@@ -126,7 +128,7 @@ Applies based on quantity purchased. Supports `min_quantity` and `max_quantity`
|
|
|
126
128
|
|
|
127
129
|
> **INFO:** Custom Price Rules can be created for specialized pricing logic. See the [Customization Quickstart](../customization/quickstart.md) for details.
|
|
128
130
|
|
|
129
|
-
## Pricing Context
|
|
131
|
+
## Pricing Context
|
|
130
132
|
|
|
131
133
|
When resolving prices, Spree considers the full context of the request:
|
|
132
134
|
|
|
@@ -155,7 +157,7 @@ Price Lists are managed in the Admin Panel under **Products → Price Lists**, o
|
|
|
155
157
|
|
|
156
158
|
Each Price List contains prices for specific variants and currencies. Products can be added to a Price List, and individual variant prices set within it.
|
|
157
159
|
|
|
158
|
-
## Price History (EU Omnibus Directive)
|
|
160
|
+
## Price History (EU Omnibus Directive)
|
|
159
161
|
|
|
160
162
|
Spree automatically records price changes for EU Omnibus Directive compliance. When a product goes on sale, EU regulations require displaying the lowest price in the preceding 30 days alongside the discounted price.
|
|
161
163
|
|
|
@@ -3,6 +3,8 @@ title: Search & Filtering
|
|
|
3
3
|
description: "Search, filter, and sort products and other resources via the Store API"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
6
8
|
## Overview
|
|
7
9
|
|
|
8
10
|
Spree provides powerful search, filtering, and sorting capabilities for products and other resources. The Store API supports:
|
|
@@ -225,7 +227,7 @@ curl 'https://api.mystore.com/api/v3/store/products?page=1&limit=24' \
|
|
|
225
227
|
|
|
226
228
|
See [Querying](../../api-reference/store-api/querying.md) for the full list of filtering, sorting, and pagination options.
|
|
227
229
|
|
|
228
|
-
## Search Providers
|
|
230
|
+
## Search Providers
|
|
229
231
|
|
|
230
232
|
Spree uses a pluggable search provider architecture. The default provider uses SQL (ILIKE + Ransack). For production catalogs with 1,000+ products, we recommend switching to [Meilisearch](../../integrations/search/meilisearch.md) for typo tolerance, relevance ranking, and faster faceted search.
|
|
231
233
|
|
|
@@ -3,6 +3,9 @@ title: Store Credits & Gift Cards
|
|
|
3
3
|
description: Stored value mechanisms for refunds, loyalty rewards, and gifting
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
8
11
|
Spree provides two stored value mechanisms that customers can use at checkout:
|
|
@@ -3,6 +3,9 @@ title: Webhooks
|
|
|
3
3
|
description: Send real-time HTTP notifications to external services when events occur in your store.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
import { Since } from '/snippets/since.mdx';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
8
11
|
Webhooks allow your Spree store to send real-time HTTP POST notifications to external services when events occur. When an order is completed, a product is updated, or inventory changes, Spree can automatically notify your CRM, fulfillment service, analytics platform, or any other system.
|