@spree/docs 0.1.305 → 0.1.307

package/dist/api-reference/admin-api/querying.md

@@ -43,7 +43,20 @@ curl -G 'https://store.example.com/api/v3/admin/orders' \
 | `gt` / `gteq` | Greater than / greater than or equal | `total_gteq: 100` | `q[total_gteq]=100` |
 | `in` | In a list | `status_in: ['complete', 'canceled']` | `q[status_in][]=complete&q[status_in][]=canceled` |
 | `null` / `not_null` | Is null / not null | `completed_at_not_null: true` | `q[completed_at_not_null]=true` |
-| `true` / `false` | Boolean | `accepts_email_marketing_true: 1` | `q[accepts_email_marketing_true]=1` |
+| `eq` on a true/false field | Is true, or is false | `accepts_email_marketing_eq: false` | `q[accepts_email_marketing_eq]=false` |
+
+### Which filters an endpoint accepts
+
+Each list endpoint accepts the attributes, associations and scopes its resource allows, and only the predicates that fit each attribute's kind of value:
+
+| Kind of value | Predicates |
+|---|---|
+| Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
+| Amounts, counts, dates and times | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
+| Statuses, prefixed IDs and types | `eq` `not_eq` `in` `not_in` `null` `not_null` |
+| True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
+
+Filters reach associated records at most two levels deep (`line_items_variant_sku_eq`). The API reference lists each documented endpoint's filters and sortable fields in its `x-spree-filters` entry, and the SDK types that endpoint's `list()` call from it, so a misspelled filter or sort field is a compile error rather than an unfiltered response. Filters your own app adds need [a one-time declaration](../../developer/core-concepts/search-filtering.md#using-your-own-filters-from-typescript) before TypeScript accepts them. List methods of endpoints the reference does not document yet accept any filter.
 
 ### Prefixed IDs in filters
 
@@ -100,9 +113,9 @@ const customers = await client.customers.list({
   tags_name_eq: 'wholesale',
 })
 
-// Products in a specific category
-const products = await client.products.list({
-  taxons_id_eq: 'ctg_xxx',
+// Orders containing a specific variant
+const orders = await client.orders.list({
+  line_items_variant_id_eq: 'variant_xxx',
 })
 ```
 

package/dist/api-reference/store-api/querying.md

@@ -37,20 +37,32 @@ curl -G 'http://localhost:3000/api/v3/store/products' \
 | `cont` | Contains (case-insensitive) | `name_cont: 'shirt'` | `q[name_cont]=shirt` |
 | `start` | Starts with | `name_start: 'Spree'` | `q[name_start]=Spree` |
 | `end` | Ends with | `slug_end: 'tote'` | `q[slug_end]=tote` |
-| `lt` | Less than | `price_lt: 50` | `q[price_lt]=50` |
-| `lteq` | Less than or equal | `price_lteq: 50` | `q[price_lteq]=50` |
-| `gt` | Greater than | `price_gt: 10` | `q[price_gt]=10` |
-| `gteq` | Greater than or equal | `price_gteq: 10` | `q[price_gteq]=10` |
+| `lt` | Less than | `available_on_lt: '2026-01-01'` | `q[available_on_lt]=2026-01-01` |
+| `lteq` | Less than or equal | `depth_lteq: 1` | `q[depth_lteq]=1` |
+| `gt` | Greater than | `products_count_gt: 0` | `q[products_count_gt]=0` |
+| `gteq` | Greater than or equal | `available_on_gteq: '2026-01-01'` | `q[available_on_gteq]=2026-01-01` |
 | `in` | In a list | `status_in: ['active', 'draft']` | `q[status_in][]=active&q[status_in][]=draft` |
 | `null` | Is null | `deleted_at_null: true` | `q[deleted_at_null]=true` |
 | `not_null` | Is not null | `completed_at_not_null: true` | `q[completed_at_not_null]=true` |
 | `present` | Is present (not empty) | `description_present: true` | `q[description_present]=true` |
 | `blank` | Is blank (null or empty) | `description_blank: true` | `q[description_blank]=true` |
-| `true` | Is true (boolean) | `purchasable_true: 1` | `q[purchasable_true]=1` |
-| `false` | Is false (boolean) | `purchasable_false: 1` | `q[purchasable_false]=1` |
+| `eq` on a true/false field | Is true, or is false | `automatic_eq: true` | `q[automatic_eq]=true` |
 
 > **NOTE:** The SDK automatically wraps filter keys in `q[...]` and appends `[]` for array values — just pass flat params.
 
+### Which filters an endpoint accepts
+
+Each list endpoint accepts the attributes, associations and scopes its resource allows, and only the predicates that fit each attribute's kind of value:
+
+| Kind of value | Predicates |
+|---|---|
+| Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
+| Amounts, counts, dates and times | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
+| Statuses, prefixed IDs and types | `eq` `not_eq` `in` `not_in` `null` `not_null` |
+| True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
+
+Filters reach associated records at most two levels deep (`categories_name_eq`). The API reference lists each documented endpoint's filters and sortable fields in its `x-spree-filters` entry, and the SDK types that endpoint's `list()` call from it, so a misspelled filter or sort field is a compile error rather than an unfiltered response. Filters your own app adds need [a one-time declaration](../../developer/core-concepts/search-filtering.md#using-your-own-filters-from-typescript) before TypeScript accepts them. List methods of endpoints the reference does not document yet accept any filter.
+
 ### Combining Filters
 
 Multiple filters are combined with AND logic:
@@ -60,8 +72,8 @@ Multiple filters are combined with AND logic:
 // Products that contain "shirt" AND cost between $20-$100
 const products = await client.products.list({
   name_cont: 'shirt',
-  price_gteq: 20,
-  price_lteq: 100,
+  price_gte: 20,
+  price_lte: 100,
 })
 ```
 
@@ -69,8 +81,8 @@ const products = await client.products.list({
 curl -G 'http://localhost:3000/api/v3/store/products' \
   -H 'X-Spree-Api-Key: pk_xxx' \
   --data-urlencode 'q[name_cont]=shirt' \
-  --data-urlencode 'q[price_gteq]=20' \
-  --data-urlencode 'q[price_lteq]=100'
+  --data-urlencode 'q[price_gte]=20' \
+  --data-urlencode 'q[price_lte]=100'
 ```