@spree/docs 0.1.229 → 0.1.231

package/dist/api-reference/store.yaml

@@ -879,8 +879,8 @@ paths:
               example:
                 data:
                 - id: prod_UkLWZg9DAJ
-                  name: Product 2116979
-                  slug: product-2116979
+                  name: Product 2506979
+                  slug: product-2506979
                   meta_title:
                   meta_description:
                   meta_keywords:
@@ -1054,8 +1054,8 @@ paths:
               example:
                 data:
                 - id: prod_UkLWZg9DAJ
-                  name: Product 2589085
-                  slug: product-2589085
+                  name: Product 2979085
+                  slug: product-2979085
                   meta_title:
                   meta_description:
                   meta_keywords:
@@ -1086,8 +1086,8 @@ paths:
                   original_price:
                   seller_id:
                 - id: prod_gbHJdmfrXB
-                  name: Product 2598209
-                  slug: product-2598209
+                  name: Product 2988209
+                  slug: product-2988209
                   meta_title:
                   meta_description:
                   meta_keywords:
@@ -1216,8 +1216,8 @@ paths:
             application/json:
               example:
                 id: prod_UkLWZg9DAJ
-                name: Product 2866885
-                slug: product-2866885
+                name: Product 3256885
+                slug: product-3256885
                 meta_title:
                 meta_description:
                 meta_keywords:
@@ -1576,8 +1576,8 @@ paths:
                     preorder_ships_at:
                     quantity: 1
                     currency: USD
-                    name: Product 185715
-                    slug: product-185715
+                    name: Product 224715
+                    slug: product-224715
                     options_text: ''
                     price: '10.0'
                     display_price: "$10.00"
@@ -1695,8 +1695,8 @@ paths:
                     preorder_ships_at:
                     quantity: 1
                     currency: USD
-                    name: Product 1862171
-                    slug: product-1862171
+                    name: Product 2252171
+                    slug: product-2252171
                     options_text: ''
                     price: '10.0'
                     display_price: "$10.00"
@@ -2004,7 +2004,7 @@ paths:
                 total_quantity: 0
                 warnings:
                 - code: line_item_removed
-                  message: Product 190307 was removed because it was sold out
+                  message: Product 229307 was removed because it was sold out
                   line_item_id: li_UkLWZg9DAJ
                   variant_id: variant_UkLWZg9DAJ
                 coupon_code:
@@ -2244,8 +2244,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 1913263
-                  slug: product-1913263
+                  name: Product 2303263
+                  slug: product-2303263
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -2530,8 +2530,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 1938992
-                  slug: product-1938992
+                  name: Product 2328992
+                  slug: product-2328992
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -2562,7 +2562,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 234 Lovely Street
+                  address1: 252 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -2584,7 +2584,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 233 Lovely Street
+                  address1: 251 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -2743,8 +2743,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 1964794
-                  slug: product-1964794
+                  name: Product 2354794
+                  slug: product-2354794
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -2878,7 +2878,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 240 Lovely Street
+                  address1: 258 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -2900,7 +2900,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 239 Lovely Street
+                  address1: 257 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -3083,8 +3083,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2252614
-                  slug: product-2252614
+                  name: Product 2642614
+                  slug: product-2642614
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -3282,8 +3282,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2263461
-                  slug: product-2263461
+                  name: Product 2653461
+                  slug: product-2653461
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -3469,8 +3469,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2288182
-                  slug: product-2288182
+                  name: Product 2678182
+                  slug: product-2678182
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -3580,7 +3580,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 336 Lovely Street
+                  address1: 354 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -3766,8 +3766,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2305702
-                  slug: product-2305702
+                  name: Product 2695702
+                  slug: product-2695702
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -4020,8 +4020,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2349569
-                  slug: product-2349569
+                  name: Product 2739569
+                  slug: product-2739569
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -4174,10 +4174,10 @@ paths:
                 total_quantity: 2
                 warnings:
                 - code: delivery_unavailable
-                  message: Product 23763 cannot be delivered to the selected address
+                  message: Product 27663 cannot be delivered to the selected address
                   line_item_id: li_UkLWZg9DAJ
                 - code: delivery_unavailable
-                  message: Product 238298 cannot be delivered to the selected address
+                  message: Product 277298 cannot be delivered to the selected address
                   line_item_id: li_gbHJdmfrXB
                 coupon_code:
                 item_total: '29.99'
@@ -4235,8 +4235,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 23763
-                  slug: product-23763
+                  name: Product 27663
+                  slug: product-27663
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -4266,8 +4266,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 238298
-                  slug: product-238298
+                  name: Product 277298
+                  slug: product-277298
                   options_text: ''
                   price: '19.99'
                   display_price: "$19.99"
@@ -4496,8 +4496,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2449165
-                  slug: product-2449165
+                  name: Product 2839165
+                  slug: product-2839165
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -5326,8 +5326,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 3069789
-                  slug: product-3069789
+                  name: Product 3459789
+                  slug: product-3459789
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -5544,8 +5544,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 308179
-                  slug: product-308179
+                  name: Product 347179
+                  slug: product-347179
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -5723,8 +5723,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 248496
-                  slug: product-248496
+                  name: Product 287496
+                  slug: product-287496
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -5842,7 +5842,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 392 Lovely Street
+                  address1: 410 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -5864,7 +5864,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 393 Lovely Street
+                  address1: 411 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -5970,7 +5970,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 198 Lovely Street
+                  address1: 216 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -5991,7 +5991,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 199 Lovely Street
+                  address1: 217 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -6012,7 +6012,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 200 Lovely Street
+                  address1: 218 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -6270,7 +6270,7 @@ paths:
                 first_name: John
                 last_name: Doe
                 full_name: John Doe
-                address1: 212 Lovely Street
+                address1: 230 Lovely Street
                 address2: Northwest
                 postal_code: '10118'
                 city: New York
@@ -6352,7 +6352,7 @@ paths:
                 first_name: John
                 last_name: Doe
                 full_name: John Doe
-                address1: 218 Lovely Street
+                address1: 236 Lovely Street
                 address2: Northwest
                 postal_code: '10118'
                 city: Los Angeles
@@ -6847,8 +6847,8 @@ paths:
                     preorder_ships_at:
                     quantity: 1
                     currency: USD
-                    name: Product 2135270
-                    slug: product-2135270
+                    name: Product 2525270
+                    slug: product-2525270
                     options_text: ''
                     price: '10.0'
                     display_price: "$10.00"
@@ -6966,7 +6966,7 @@ paths:
                     first_name: John
                     last_name: Doe
                     full_name: John Doe
-                    address1: 284 Lovely Street
+                    address1: 302 Lovely Street
                     address2: Northwest
                     postal_code: '10118'
                     city: New York
@@ -6988,7 +6988,7 @@ paths:
                     first_name: John
                     last_name: Doe
                     full_name: John Doe
-                    address1: 285 Lovely Street
+                    address1: 303 Lovely Street
                     address2: Northwest
                     postal_code: '10118'
                     city: New York
@@ -7169,8 +7169,8 @@ paths:
                   preorder_ships_at:
                   quantity: 1
                   currency: USD
-                  name: Product 2155633
-                  slug: product-2155633
+                  name: Product 2545633
+                  slug: product-2545633
                   options_text: ''
                   price: '10.0'
                   display_price: "$10.00"
@@ -7288,7 +7288,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 290 Lovely Street
+                  address1: 308 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7310,7 +7310,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 291 Lovely Street
+                  address1: 309 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7531,7 +7531,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 296 Lovely Street
+                  address1: 314 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7552,7 +7552,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 297 Lovely Street
+                  address1: 315 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7574,7 +7574,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 297 Lovely Street
+                  address1: 315 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7596,7 +7596,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 296 Lovely Street
+                  address1: 314 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7688,7 +7688,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 298 Lovely Street
+                  address1: 316 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7709,7 +7709,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 299 Lovely Street
+                  address1: 317 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7731,7 +7731,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 299 Lovely Street
+                  address1: 317 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -7753,7 +7753,7 @@ paths:
                   first_name: John
                   last_name: Doe
                   full_name: John Doe
-                  address1: 298 Lovely Street
+                  address1: 316 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -9732,7 +9732,7 @@ paths:
                 variant:
                   id: variant_gbHJdmfrXB
                   product_id: prod_gbHJdmfrXB
-                  sku: SKU-366
+                  sku: SKU-435
                   options_text: ''
                   track_inventory: true
                   media_count: 0
@@ -10663,7 +10663,7 @@ paths:
                   first_name:
                   last_name:
                   full_name: ''
-                  address1: 257 Lovely Street
+                  address1: 275 Lovely Street
                   address2: Northwest
                   postal_code: '10118'
                   city: New York
@@ -10734,7 +10734,7 @@ paths:
                 first_name:
                 last_name:
                 full_name: ''
-                address1: 260 Lovely Street
+                address1: 278 Lovely Street
                 address2: Northwest
                 postal_code: '10118'
                 city: New York
@@ -10913,8 +10913,8 @@ paths:
                     preorder_ships_at:
                     quantity: 1
                     currency: USD
-                    name: Product 2125649
-                    slug: product-2125649
+                    name: Product 2515649
+                    slug: product-2515649
                     options_text: ''
                     price: '10.0'
                     display_price: "$10.00"
@@ -11032,7 +11032,7 @@ paths:
                     first_name: John
                     last_name: Doe
                     full_name: John Doe
-                    address1: 268 Lovely Street
+                    address1: 286 Lovely Street
                     address2: Northwest
                     postal_code: '10118'
                     city: New York
@@ -11054,7 +11054,7 @@ paths:
                     first_name: John
                     last_name: Doe
                     full_name: John Doe
-                    address1: 269 Lovely Street
+                    address1: 287 Lovely Street
                     address2: Northwest
                     postal_code: '10118'
                     city: New York

package/dist/developer/agentic/agent-skills.md

@@ -52,7 +52,7 @@ The plugin delivers everything the skills CLI does **plus** `/spree:doctor`, `/s
 
 The skills detect your project flavor before running commands:
 
-- **create-spree-app projects** (Docker, Rails app in `backend/`) — commands route through the [Spree CLI](../cli/quickstart.md) (`spree migrate`, `spree console`, …).
+- **create-spree-app projects** (Docker, Rails app in `server/`) — commands route through the [Spree CLI](../cli/quickstart.md) (`spree migrate`, `spree console`, …).
 - **Classic Rails apps** (Spree gems in a plain Rails app, no Docker — typical for apps created before Spree 5.4) — the skills fall back to native commands (`bin/rails`, `bundle exec rake`) from the app root.
 
 ## Updating

package/dist/developer/cli/quickstart.md

@@ -114,13 +114,13 @@ Production upgrades only need the third stage — `bundle install` and `db:migra
 
 ### `spree eject`
 
-Switch from the prebuilt Docker image to building from your local `backend/` directory. This lets you customize the Rails app — add gems, override models, add migrations, etc.
+Switch from the prebuilt Docker image to building from your local `server/` directory. This lets you customize the Rails app — add gems, override models, add migrations, etc.
 
 ```bash
 spree eject
 ```
 
-After ejecting, the Docker image is built from `backend/Dockerfile`. Edit files in `backend/` and run `spree dev` to rebuild and restart with your changes.
+After ejecting, the Docker image is built from `server/Dockerfile`. Edit files in `server/` and run `spree dev` to rebuild and restart with your changes.
 
 See [Customizing the Backend](../create-spree-app/quickstart.md#customizing-the-backend) for details on what you can customize.
 

package/dist/developer/core-concepts/addresses.md

@@ -126,6 +126,7 @@ curl -X POST 'https://api.mystore.com/api/v3/store/customers/me/addresses' \
 
 On a cart you can point at a saved address or send a new one inline:
 
+
 ```typescript Store SDK
 // Reuse something from the address book
 await client.carts.update(cartId, {
@@ -148,6 +149,18 @@ await client.carts.update(cartId, {
 })
 ```
 
+```bash cURL
+curl -X PATCH 'https://api.mystore.com/api/v3/store/carts/cart_xxx' \
+  -H 'X-Spree-API-Key: pk_xxx' \
+  -H 'Authorization: Bearer $CUSTOMER_JWT' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "shipping_address_id": "addr_xxx",
+    "billing_address_id": "addr_yyy"
+  }'
+```
+
+
 Setting the shipping address is what makes delivery options and tax appear, so do it before asking the customer to choose delivery. The updated cart comes back with new totals — you don't need a second request.
 
 > **WARNING:** An address is **copied onto the order** when the cart completes, not linked to. Editing a saved address next year does not rewrite last year's invoice — which is exactly what you want when a customer moves house.

package/dist/developer/core-concepts/calculators.md

@@ -94,7 +94,7 @@ const calculators = await adminClient.deliveryMethods.calculators()
 await adminClient.deliveryMethods.create({
   name: 'Standard shipping',
   delivery_zone_id: 'dz_xxx',
-  calculator_type: 'Spree::Calculator::Shipping::FlatRate',
+  calculator_type: 'flat_rate',
   calculator_attributes: {
     preferences: { amount: '7.00', currency: 'USD' },
   },
@@ -105,6 +105,11 @@ await adminClient.deliveryMethods.create({
 spree api get /delivery_methods/calculators
 ```
 
+```bash cURL
+curl 'https://api.mystore.com/api/v3/admin/delivery_methods/calculators' \
+  -H 'X-Spree-API-Key: sk_xxx'
+```
+
 
 Each calculator declares which settings it takes, so a form can be built for it without knowing the calculator in advance — which is how the dashboard renders these.
 

package/dist/developer/core-concepts/carts.md

@@ -101,15 +101,24 @@ Every change returns the whole cart with new totals, so you never need a second
 
 When a guest signs in, attach their cart to the account:
 
+
 ```typescript Store SDK
 await client.carts.associate(cartId, { spreeToken: 'abc123' })
 ```
 
+```bash cURL
+curl -X POST 'https://api.mystore.com/api/v3/store/carts/cart_xxx/associate' \
+  -H 'X-Spree-API-Key: pk_xxx' \
+  -H 'Authorization: Bearer $CUSTOMER_JWT' \
+  -H 'X-Spree-Token: abc123'
+```
+
+
 ## Checkout requirements
 
 A cart tells you what it still needs before it can be completed:
 
-```json
+```json Response
 {
   "requirements": [
     {
@@ -176,12 +185,21 @@ For providers like Stripe, create a payment session and confirm it with their ow
 
 Discount codes, gift cards and store credit can be applied any time before completion:
 
+
 ```typescript Store SDK
 await client.carts.discountCodes.apply(cartId, 'SUMMER20')
 await client.carts.giftCards.apply(cartId, 'GIFT-XXXX')
 await client.carts.storeCredits.apply(cartId)
 ```
 
+```bash cURL
+curl -X POST 'https://api.mystore.com/api/v3/store/carts/cart_xxx/discount_codes' \
+  -H 'X-Spree-API-Key: pk_xxx' \
+  -H 'Content-Type: application/json' \
+  -d '{ "code": "SUMMER20" }'
+```
+
+
 ## What completion guarantees
 
 Completing a cart moves real money, so Spree is careful about it: