@spree/docs 0.1.94 → 0.1.96

package/dist/developer/cli/admin-api.md

@@ -9,7 +9,7 @@ The `spree api` command group turns the CLI into a first-class Admin API client:
 ```bash
 spree api get /products -q status_eq=active --sort -created_at --limit 10
 spree api get /orders/ord_x8k2J9aQ --expand items,payments
-spree api post /products -d '{"name":"Classic Tee"}'
+spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'
 spree api patch /orders/ord_x8k2J9aQ/cancel
 spree api endpoints --resource orders
 spree api schema "POST /orders/{id}/refunds"
@@ -93,7 +93,7 @@ spree api get /products --limit 5 | jq '.data[].name'
 Request bodies are flat JSON (no root wrapping), inline, from a file, or from stdin:
 
 ```bash
-spree api post /products -d '{"name":"Classic Tee","price":29.99}'
+spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'
 spree api post /orders/ord_x8k2J9aQ/refunds -d @refund.json
 cat prices.json | spree api post /prices/bulk_upsert -d -
 spree api delete /products/prod_86Rf07xd
@@ -101,6 +101,28 @@ spree api delete /products/prod_86Rf07xd
 
 Mutations automatically carry an `Idempotency-Key`, so retries are safe.
 
+### Creating products
+
+A product is a catalog grouping; everything purchasable — SKU, price, stock, weight — lives on its variants. For a **simple product** with no options, ship a top-level `prices` array and Spree creates the single backing variant for you:
+
+```bash
+spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'
+```
+
+For a product with options, send the `variants` array, each with its own `options` and `prices` (and optionally `stock_items`):
+
+```bash
+spree api post /products -d '{
+  "name": "Classic Tee",
+  "variants": [
+    { "sku": "TEE-S", "options": [{"name":"size","value":"Small"}], "prices": [{"currency":"USD","amount":"29.99"}] },
+    { "sku": "TEE-M", "options": [{"name":"size","value":"Medium"}], "prices": [{"currency":"USD","amount":"29.99"}] }
+  ]
+}'
+```
+
+Run `spree api schema "POST /products"` for the full request body.
+
 ## Discovering endpoints and schemas
 
 The CLI bundles a snapshot of the Admin API OpenAPI spec, so discovery works offline:

package/dist/developer/cli/quickstart.md

@@ -12,7 +12,7 @@ The Spree CLI (`@spree/cli`) does two things from your terminal:
 ```bash
 spree dev                                                  # boot the project
 spree api get /orders -q status_eq=complete --limit 10     # query the Admin API
-spree api post /products -d '{"name":"Classic Tee"}'       # create a resource
+spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'  # create a resource
 spree api endpoints --search refund                        # discover endpoints, offline
 ```
 
@@ -192,7 +192,7 @@ Call the Admin API with generic `get`/`post`/`patch`/`delete` commands — zero-
 
 ```bash
 spree api get /products -q status_eq=active --limit 10
-spree api post /products -d '{"name":"Classic Tee"}'
+spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'
 spree api endpoints --resource orders    # endpoints + required scopes, offline
 spree api schema "POST /orders"          # request/response schema, offline
 spree api status

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

@@ -355,12 +355,12 @@ Capture or void an authorized payment, and issue refunds, through the nested ord
 ```typescript Admin SDK
 await client.orders.payments.capture('or_xxx', 'pay_xxx')
 await client.orders.payments.void('or_xxx', 'pay_xxx')
-await client.orders.refunds.create('or_xxx', { payment_id: 'pay_xxx', amount: 19.99 })
+await client.orders.refunds.create('or_xxx', { payment_id: 'pay_xxx', amount: '19.99' })
 ```
 
 ```bash CLI
 spree api patch /orders/or_xxx/payments/pay_xxx/capture
-spree api post /orders/or_xxx/refunds -d '{"payment_id": "pay_xxx", "amount": 19.99}'
+spree api post /orders/or_xxx/refunds -d '{"payment_id": "pay_xxx", "amount": "19.99"}'
 ```
 
 

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

@@ -15,8 +15,8 @@ Each variant has one or more `Price` records — one per currency. The API autom
 
 | Attribute | Description | Example |
 |-----------|-------------|---------|
-| `amount` | Current selling price | `99.90` |
-| `compare_at_amount` | Original/compare price for strikethrough display | `129.90` |
+| `amount` | Current selling price | `"99.90"` |
+| `compare_at_amount` | Original/compare price for strikethrough display | `"129.90"` |
 | `currency` | ISO 4217 currency code | `USD` |
 
 > **WARNING:** If a product doesn't have a price in the selected currency, it won't appear in Store API responses by default.
@@ -73,13 +73,13 @@ const client = createAdminClient({
 })
 
 // Set / change one variant's price in a currency
-await client.prices.create({ variant_id: 'variant_xxx', currency: 'USD', amount: 15.99 })
+await client.prices.create({ variant_id: 'variant_xxx', currency: 'USD', amount: '15.99' })
 
 // Upsert many at once
 await client.prices.bulkUpsert({
   prices: [
-    { variant_id: 'variant_xxx', currency: 'USD', amount: 15.99 },
-    { variant_id: 'variant_xxx', currency: 'EUR', amount: 14.99 },
+    { variant_id: 'variant_xxx', currency: 'USD', amount: '15.99' },
+    { variant_id: 'variant_xxx', currency: 'EUR', amount: '14.99' },
   ],
 })
 ```
@@ -87,8 +87,8 @@ await client.prices.bulkUpsert({
 ```bash CLI
 spree api post /prices/bulk_upsert -d '{
   "prices": [
-    { "variant_id": "variant_xxx", "currency": "USD", "amount": 15.99 },
-    { "variant_id": "variant_xxx", "currency": "EUR", "amount": 14.99 }
+    { "variant_id": "variant_xxx", "currency": "USD", "amount": "15.99" },
+    { "variant_id": "variant_xxx", "currency": "EUR", "amount": "14.99" }
   ]
 }'
 ```

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

@@ -183,7 +183,7 @@ const product = await client.products.create({
         { name: 'size', value: 'Small' },
         { name: 'color', value: 'navy' },
       ],
-      prices: [{ currency: 'USD', amount: 29.99 }],
+      prices: [{ currency: 'USD', amount: '29.99' }],
       stock_items: [{ stock_location_id: 'sloc_xxx', count_on_hand: 50 }],
     },
   ],
@@ -197,7 +197,7 @@ spree api post /products -d '{
   "variants": [{
     "sku": "TSHIRT-S-NAVY",
     "options": [{ "name": "size", "value": "Small" }],
-    "prices": [{ "currency": "USD", "amount": 29.99 }]
+    "prices": [{ "currency": "USD", "amount": "29.99" }]
   }]
 }'
 ```
@@ -302,7 +302,7 @@ const variant = await client.products.variants.create('prod_xxx', {
     { name: 'size', value: 'Large' },
     { name: 'color', value: 'Red' },
   ],
-  prices: [{ currency: 'USD', amount: 24.99 }],
+  prices: [{ currency: 'USD', amount: '24.99' }],
   stock_items: [{ stock_location_id: 'sloc_xxx', count_on_hand: 30 }],
 })
 ```
@@ -311,7 +311,7 @@ const variant = await client.products.variants.create('prod_xxx', {
 spree api post /products/prod_xxx/variants -d '{
   "sku": "TEE-L-R",
   "options": [{ "name": "size", "value": "Large" }],
-  "prices": [{ "currency": "USD", "amount": 24.99 }]
+  "prices": [{ "currency": "USD", "amount": "24.99" }]
 }'
 ```
 

package/dist/developer/core-concepts/store-credits-gift-cards.md

@@ -133,7 +133,7 @@ const client = createAdminClient({
 })
 
 const credit = await client.customers.storeCredits.create('cus_xxx', {
-  amount: 25.0,
+  amount: '25.00',
   currency: 'USD',
   category_id: 'sccat_xxx',
   memo: 'Goodwill credit for delayed shipment',
@@ -142,7 +142,7 @@ const credit = await client.customers.storeCredits.create('cus_xxx', {
 
 ```bash CLI
 spree api post /customers/cus_xxx/store_credits -d '{
-  "amount": 25.0,
+  "amount": "25.00",
   "currency": "USD",
   "category_id": "sccat_xxx",
   "memo": "Goodwill credit"
@@ -258,7 +258,7 @@ const client = createAdminClient({
 })
 
 const giftCard = await client.giftCards.create({
-  amount: 50,
+  amount: '50.00',
   currency: 'USD',
   expires_at: '2026-12-31',
 })
@@ -268,7 +268,7 @@ console.log(giftCard.code) // share this with the recipient
 
 ```bash CLI
 spree api post /gift_cards -d '{
-  "amount": 50,
+  "amount": "50.00",
   "currency": "USD",
   "expires_at": "2026-12-31"
 }'
@@ -295,7 +295,7 @@ Batches can also be created via the Admin API:
 const batch = await client.giftCardBatches.create({
   prefix: 'HOLIDAY',
   codes_count: 1000,
-  amount: 25,
+  amount: '25.00',
   currency: 'USD',
   expires_at: '2026-12-31',
 })
@@ -305,7 +305,7 @@ const batch = await client.giftCardBatches.create({
 spree api post /gift_card_batches -d '{
   "prefix": "HOLIDAY",
   "codes_count": 1000,
-  "amount": 25,
+  "amount": "25.00",
   "currency": "USD",
   "expires_at": "2026-12-31"
 }'

package/dist/developer/getting-started/quickstart.md

@@ -73,6 +73,26 @@ Upon successful authentication, you should see the admin screen:
 
 <img src="/images/spree_admin_dashboard.png" />
 
+## Using the Spree CLI
+
+Projects scaffolded with `create-spree-app` include [`@spree/cli`](../cli/quickstart.md) for managing the backend and calling the Admin API. Because it's a project dependency, run it with `npx` (or any package-manager script):
+
+```bash
+npx spree dev               # boot the Docker stack
+npx spree api get products  # query the Admin API (read-only key preconfigured)
+```
+
+Project setup mints a read-only Admin API key into `.spree/credentials.json` (and `spree api` mints it on first use if you skipped setup), so `spree api` works without any extra configuration.
+
+To call `spree` directly without the `npx` prefix, install the CLI globally:
+
+```bash
+npm install -g @spree/cli
+spree api get products
+```
+
+See the [Spree CLI guide](../cli/quickstart.md) for all commands and the [Admin API from the CLI](../cli/admin-api.md) for querying your store's data.
+
 ## Next Steps
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spree/docs",
-  "version": "0.1.94",
+  "version": "0.1.96",
   "description": "Spree Commerce developer documentation for AI agents and local reference",
   "type": "module",
   "license": "CC-BY-4.0",