@spree/docs 0.1.235 → 0.1.237

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.
Files changed (5) hide show
  1. package/dist/api-reference/admin-api/authentication.md +45 -0
  2. package/dist/api-reference/store.yaml +130 -130
  3. package/dist/developer/core-concepts/reporting.md +1 -1
  4. package/dist/developer/upgrades/5.6-to-6.0.md +16 -0
  5. package/package.json +1 -1
package/dist/api-reference/admin-api/authentication.md CHANGED
@@ -177,3 +177,48 @@ If the caller lacks permission for a specific action, the API returns `403 Forbi
177
177
  | JWT token | `Authorization: Bearer <token>` | Interactive admin sessions; SPA | CanCanCan abilities |
178
178
 
179
179
  > **NOTE:** If both headers are present, the JWT token wins: CanCanCan applies and scopes are ignored. This lets you use `sk_xxx` to bootstrap a session and then issue per-user JWTs for individual admin actions.
180
+
181
+ ## Who a write is attributed to
182
+
183
+ Records that remember who acted on them — an order's `canceler`, `approver`
184
+ and `created_by`, a refund's `refunder`, the opener of a return, exchange or
185
+ claim, the receiver of a stock delivery — name whichever credential made the
186
+ call. A JWT request records the signed-in admin; a secret-key request records
187
+ the key itself, so a warehouse connector's write is attributed to the
188
+ connector rather than to nobody.
189
+
190
+ Each of these fields comes as a pair. The `*_id` is a prefixed id, `adm_…`
191
+ for a person and `key_…` for a key, and the `*_type` beside it says which:
192
+
193
+ ```json
194
+ {
195
+ "canceler_id": "key_8QrN3xLq",
196
+ "canceler_type": "api_key",
197
+ "canceled_at": "2026-09-16T11:04:22Z"
198
+ }
199
+ ```
200
+
201
+ `*_type` is `admin_user` or `api_key` today, and an extension may register
202
+ further kinds, so treat the value as an open list rather than a closed set.
203
+ Expanding the association gives the same three facts in one object — `id`,
204
+ `type` and a `label` fit to show in a timeline:
205
+
206
+ **SDK:**
207
+
208
+ ```ts
209
+ const order = await client.orders.retrieve('or_m3Rp9wXz', { expand: ['canceler'] })
210
+
211
+ order.canceler // { id: 'key_8QrN3xLq', type: 'api_key', label: 'WMS connector' }
212
+ ```
213
+
214
+ **cURL:**
215
+
216
+ ```bash
217
+ curl "https://example.com/api/v3/admin/orders/or_m3Rp9wXz?expand=canceler" \
218
+ -H "X-Spree-Api-Key: sk_xxx"
219
+ ```
220
+
221
+
222
+ > **NOTE:** Attribution answers *who*, not *through which surface*. A store upgrading from
223
+ > an earlier release should run `rake spree:upgrade:backfill_actor_types` so
224
+ > existing records name the kind of actor they already held.
package/dist/api-reference/store.yaml CHANGED
@@ -92,12 +92,12 @@ paths:
92
92
  user:
93
93
  id: cust_UkLWZg9DAJ
94
94
  email: test@example.com
95
- first_name: Lenny
96
- last_name: Kuhlman
95
+ first_name: Julie
96
+ last_name: Bode
97
97
  phone:
98
98
  accepts_email_marketing: false
99
99
  email_marketing_consent_updated_at: '2026-01-15T12:00:00Z'
100
- full_name: Lenny Kuhlman
100
+ full_name: Julie Bode
101
101
  available_store_credit_total: '0'
102
102
  display_available_store_credit_total: "$0.00"
103
103
  addresses: []
@@ -200,12 +200,12 @@ paths:
200
200
  user:
201
201
  id: cust_UkLWZg9DAJ
202
202
  email: test@example.com
203
- first_name: Tijuana
204
- last_name: Konopelski
203
+ first_name: Yuki
204
+ last_name: Harvey
205
205
  phone:
206
206
  accepts_email_marketing: false
207
207
  email_marketing_consent_updated_at: '2026-01-15T12:00:00Z'
208
- full_name: Tijuana Konopelski
208
+ full_name: Yuki Harvey
209
209
  available_store_credit_total: '0'
210
210
  display_available_store_credit_total: "$0.00"
211
211
  addresses: []
@@ -879,8 +879,8 @@ paths:
879
879
  example:
880
880
  data:
881
881
  - id: prod_UkLWZg9DAJ
882
- name: Product 2506979
883
- slug: product-2506979
882
+ name: Product 2516979
883
+ slug: product-2516979
884
884
  meta_title:
885
885
  meta_description:
886
886
  meta_keywords:
@@ -1054,8 +1054,8 @@ paths:
1054
1054
  example:
1055
1055
  data:
1056
1056
  - id: prod_UkLWZg9DAJ
1057
- name: Product 2979085
1058
- slug: product-2979085
1057
+ name: Product 2989085
1058
+ slug: product-2989085
1059
1059
  meta_title:
1060
1060
  meta_description:
1061
1061
  meta_keywords:
@@ -1086,8 +1086,8 @@ paths:
1086
1086
  original_price:
1087
1087
  seller_id:
1088
1088
  - id: prod_gbHJdmfrXB
1089
- name: Product 2988209
1090
- slug: product-2988209
1089
+ name: Product 2998209
1090
+ slug: product-2998209
1091
1091
  meta_title:
1092
1092
  meta_description:
1093
1093
  meta_keywords:
@@ -1216,8 +1216,8 @@ paths:
1216
1216
  application/json:
1217
1217
  example:
1218
1218
  id: prod_UkLWZg9DAJ
1219
- name: Product 3256885
1220
- slug: product-3256885
1219
+ name: Product 3266885
1220
+ slug: product-3266885
1221
1221
  meta_title:
1222
1222
  meta_description:
1223
1223
  meta_keywords:
@@ -1576,8 +1576,8 @@ paths:
1576
1576
  preorder_ships_at:
1577
1577
  quantity: 1
1578
1578
  currency: USD
1579
- name: Product 224715
1580
- slug: product-224715
1579
+ name: Product 225715
1580
+ slug: product-225715
1581
1581
  options_text: ''
1582
1582
  price: '10.0'
1583
1583
  display_price: "$10.00"
@@ -1695,8 +1695,8 @@ paths:
1695
1695
  preorder_ships_at:
1696
1696
  quantity: 1
1697
1697
  currency: USD
1698
- name: Product 2252171
1699
- slug: product-2252171
1698
+ name: Product 2262171
1699
+ slug: product-2262171
1700
1700
  options_text: ''
1701
1701
  price: '10.0'
1702
1702
  display_price: "$10.00"
@@ -2004,7 +2004,7 @@ paths:
2004
2004
  total_quantity: 0
2005
2005
  warnings:
2006
2006
  - code: line_item_removed
2007
- message: Product 229307 was removed because it was sold out
2007
+ message: Product 230307 was removed because it was sold out
2008
2008
  line_item_id: li_UkLWZg9DAJ
2009
2009
  variant_id: variant_UkLWZg9DAJ
2010
2010
  coupon_code:
@@ -2244,8 +2244,8 @@ paths:
2244
2244
  preorder_ships_at:
2245
2245
  quantity: 1
2246
2246
  currency: USD
2247
- name: Product 2303263
2248
- slug: product-2303263
2247
+ name: Product 2313263
2248
+ slug: product-2313263
2249
2249
  options_text: ''
2250
2250
  price: '10.0'
2251
2251
  display_price: "$10.00"
@@ -2470,7 +2470,7 @@ paths:
2470
2470
  po_document_byte_size:
2471
2471
  number: cart_UkLWZg9DAJ
2472
2472
  token: rrGvkDXx3KcQVwLVk8XiVCVk
2473
- email: tarah@tromp.com
2473
+ email: steve@tromp.com
2474
2474
  customer_note:
2475
2475
  po_number:
2476
2476
  currency: USD
@@ -2530,8 +2530,8 @@ paths:
2530
2530
  preorder_ships_at:
2531
2531
  quantity: 1
2532
2532
  currency: USD
2533
- name: Product 2328992
2534
- slug: product-2328992
2533
+ name: Product 2338992
2534
+ slug: product-2338992
2535
2535
  options_text: ''
2536
2536
  price: '10.0'
2537
2537
  display_price: "$10.00"
@@ -2562,7 +2562,7 @@ paths:
2562
2562
  first_name: John
2563
2563
  last_name: Doe
2564
2564
  full_name: John Doe
2565
- address1: 252 Lovely Street
2565
+ address1: 254 Lovely Street
2566
2566
  address2: Northwest
2567
2567
  postal_code: '10118'
2568
2568
  city: New York
@@ -2584,7 +2584,7 @@ paths:
2584
2584
  first_name: John
2585
2585
  last_name: Doe
2586
2586
  full_name: John Doe
2587
- address1: 251 Lovely Street
2587
+ address1: 253 Lovely Street
2588
2588
  address2: Northwest
2589
2589
  postal_code: '10118'
2590
2590
  city: New York
@@ -2743,8 +2743,8 @@ paths:
2743
2743
  preorder_ships_at:
2744
2744
  quantity: 1
2745
2745
  currency: USD
2746
- name: Product 2354794
2747
- slug: product-2354794
2746
+ name: Product 2364794
2747
+ slug: product-2364794
2748
2748
  options_text: ''
2749
2749
  price: '10.0'
2750
2750
  display_price: "$10.00"
@@ -2798,8 +2798,8 @@ paths:
2798
2798
  deliveries: []
2799
2799
  delivery_method:
2800
2800
  id: dm_UkLWZg9DAJ
2801
- name: UPS Ground
2802
- code: UPS_GROUND
2801
+ name: UPS Ground 113
2802
+ code: UPS_GROUND_130
2803
2803
  estimated_transit_business_days_min:
2804
2804
  estimated_transit_business_days_max:
2805
2805
  digital: false
@@ -2820,7 +2820,7 @@ paths:
2820
2820
  delivery_rates:
2821
2821
  - id: dr_gbHJdmfrXB
2822
2822
  delivery_method_id: dm_UkLWZg9DAJ
2823
- name: UPS Ground
2823
+ name: UPS Ground 113
2824
2824
  selected: true
2825
2825
  cost: '10.0'
2826
2826
  total: '10.0'
@@ -2839,8 +2839,8 @@ paths:
2839
2839
  display_tax_total: "$0.00"
2840
2840
  delivery_method:
2841
2841
  id: dm_UkLWZg9DAJ
2842
- name: UPS Ground
2843
- code: UPS_GROUND
2842
+ name: UPS Ground 113
2843
+ code: UPS_GROUND_130
2844
2844
  estimated_transit_business_days_min:
2845
2845
  estimated_transit_business_days_max:
2846
2846
  digital: false
@@ -2867,7 +2867,7 @@ paths:
2867
2867
  gateway_payment_profile_id:
2868
2868
  payment_method:
2869
2869
  id: pm_UkLWZg9DAJ
2870
- name: Check
2870
+ name: Check 5
2871
2871
  description:
2872
2872
  type: check
2873
2873
  session_required: false
@@ -2878,7 +2878,7 @@ paths:
2878
2878
  first_name: John
2879
2879
  last_name: Doe
2880
2880
  full_name: John Doe
2881
- address1: 258 Lovely Street
2881
+ address1: 260 Lovely Street
2882
2882
  address2: Northwest
2883
2883
  postal_code: '10118'
2884
2884
  city: New York
@@ -2900,7 +2900,7 @@ paths:
2900
2900
  first_name: John
2901
2901
  last_name: Doe
2902
2902
  full_name: John Doe
2903
- address1: 257 Lovely Street
2903
+ address1: 259 Lovely Street
2904
2904
  address2: Northwest
2905
2905
  postal_code: '10118'
2906
2906
  city: New York
@@ -3083,8 +3083,8 @@ paths:
3083
3083
  preorder_ships_at:
3084
3084
  quantity: 1
3085
3085
  currency: USD
3086
- name: Product 2642614
3087
- slug: product-2642614
3086
+ name: Product 2652614
3087
+ slug: product-2652614
3088
3088
  options_text: ''
3089
3089
  price: '10.0'
3090
3090
  display_price: "$10.00"
@@ -3282,8 +3282,8 @@ paths:
3282
3282
  preorder_ships_at:
3283
3283
  quantity: 1
3284
3284
  currency: USD
3285
- name: Product 2653461
3286
- slug: product-2653461
3285
+ name: Product 2663461
3286
+ slug: product-2663461
3287
3287
  options_text: ''
3288
3288
  price: '10.0'
3289
3289
  display_price: "$10.00"
@@ -3469,8 +3469,8 @@ paths:
3469
3469
  preorder_ships_at:
3470
3470
  quantity: 1
3471
3471
  currency: USD
3472
- name: Product 2678182
3473
- slug: product-2678182
3472
+ name: Product 2688182
3473
+ slug: product-2688182
3474
3474
  options_text: ''
3475
3475
  price: '10.0'
3476
3476
  display_price: "$10.00"
@@ -3524,8 +3524,8 @@ paths:
3524
3524
  deliveries: []
3525
3525
  delivery_method:
3526
3526
  id: dm_UkLWZg9DAJ
3527
- name: UPS Ground
3528
- code: UPS_GROUND
3527
+ name: UPS Ground 130
3528
+ code: UPS_GROUND_148
3529
3529
  estimated_transit_business_days_min:
3530
3530
  estimated_transit_business_days_max:
3531
3531
  digital: false
@@ -3546,7 +3546,7 @@ paths:
3546
3546
  delivery_rates:
3547
3547
  - id: dr_gbHJdmfrXB
3548
3548
  delivery_method_id: dm_UkLWZg9DAJ
3549
- name: UPS Ground
3549
+ name: UPS Ground 130
3550
3550
  selected: true
3551
3551
  cost: '10.0'
3552
3552
  total: '10.0'
@@ -3565,8 +3565,8 @@ paths:
3565
3565
  display_tax_total: "$0.00"
3566
3566
  delivery_method:
3567
3567
  id: dm_UkLWZg9DAJ
3568
- name: UPS Ground
3569
- code: UPS_GROUND
3568
+ name: UPS Ground 130
3569
+ code: UPS_GROUND_148
3570
3570
  estimated_transit_business_days_min:
3571
3571
  estimated_transit_business_days_max:
3572
3572
  digital: false
@@ -3580,7 +3580,7 @@ paths:
3580
3580
  first_name: John
3581
3581
  last_name: Doe
3582
3582
  full_name: John Doe
3583
- address1: 354 Lovely Street
3583
+ address1: 356 Lovely Street
3584
3584
  address2: Northwest
3585
3585
  postal_code: '10118'
3586
3586
  city: New York
@@ -3766,8 +3766,8 @@ paths:
3766
3766
  preorder_ships_at:
3767
3767
  quantity: 1
3768
3768
  currency: USD
3769
- name: Product 2695702
3770
- slug: product-2695702
3769
+ name: Product 2705702
3770
+ slug: product-2705702
3771
3771
  options_text: ''
3772
3772
  price: '10.0'
3773
3773
  display_price: "$10.00"
@@ -4020,8 +4020,8 @@ paths:
4020
4020
  preorder_ships_at:
4021
4021
  quantity: 1
4022
4022
  currency: USD
4023
- name: Product 2739569
4024
- slug: product-2739569
4023
+ name: Product 2749569
4024
+ slug: product-2749569
4025
4025
  options_text: ''
4026
4026
  price: '10.0'
4027
4027
  display_price: "$10.00"
@@ -4174,10 +4174,10 @@ paths:
4174
4174
  total_quantity: 2
4175
4175
  warnings:
4176
4176
  - code: delivery_unavailable
4177
- message: Product 27663 cannot be delivered to the selected address
4177
+ message: Product 27763 cannot be delivered to the selected address
4178
4178
  line_item_id: li_UkLWZg9DAJ
4179
4179
  - code: delivery_unavailable
4180
- message: Product 277298 cannot be delivered to the selected address
4180
+ message: Product 278298 cannot be delivered to the selected address
4181
4181
  line_item_id: li_gbHJdmfrXB
4182
4182
  coupon_code:
4183
4183
  item_total: '29.99'
@@ -4235,8 +4235,8 @@ paths:
4235
4235
  preorder_ships_at:
4236
4236
  quantity: 1
4237
4237
  currency: USD
4238
- name: Product 27663
4239
- slug: product-27663
4238
+ name: Product 27763
4239
+ slug: product-27763
4240
4240
  options_text: ''
4241
4241
  price: '10.0'
4242
4242
  display_price: "$10.00"
@@ -4266,8 +4266,8 @@ paths:
4266
4266
  preorder_ships_at:
4267
4267
  quantity: 1
4268
4268
  currency: USD
4269
- name: Product 277298
4270
- slug: product-277298
4269
+ name: Product 278298
4270
+ slug: product-278298
4271
4271
  options_text: ''
4272
4272
  price: '19.99'
4273
4273
  display_price: "$19.99"
@@ -4496,8 +4496,8 @@ paths:
4496
4496
  preorder_ships_at:
4497
4497
  quantity: 1
4498
4498
  currency: USD
4499
- name: Product 2839165
4500
- slug: product-2839165
4499
+ name: Product 2849165
4500
+ slug: product-2849165
4501
4501
  options_text: ''
4502
4502
  price: '10.0'
4503
4503
  display_price: "$10.00"
@@ -4783,7 +4783,7 @@ paths:
4783
4783
  cart_id: cart_UkLWZg9DAJ
4784
4784
  payment_method:
4785
4785
  id: pm_UkLWZg9DAJ
4786
- name: Credit Card
4786
+ name: Credit Card 121
4787
4787
  description:
4788
4788
  type: bogus
4789
4789
  session_required: true
@@ -4884,7 +4884,7 @@ paths:
4884
4884
  cart_id: cart_UkLWZg9DAJ
4885
4885
  payment_method:
4886
4886
  id: pm_UkLWZg9DAJ
4887
- name: Credit Card
4887
+ name: Credit Card 122
4888
4888
  description:
4889
4889
  type: bogus
4890
4890
  session_required: true
@@ -4952,7 +4952,7 @@ paths:
4952
4952
  cart_id: cart_UkLWZg9DAJ
4953
4953
  payment_method:
4954
4954
  id: pm_UkLWZg9DAJ
4955
- name: Credit Card
4955
+ name: Credit Card 124
4956
4956
  description:
4957
4957
  type: bogus
4958
4958
  session_required: true
@@ -5060,7 +5060,7 @@ paths:
5060
5060
  cart_id: cart_UkLWZg9DAJ
5061
5061
  payment_method:
5062
5062
  id: pm_UkLWZg9DAJ
5063
- name: Credit Card
5063
+ name: Credit Card 125
5064
5064
  description:
5065
5065
  type: bogus
5066
5066
  session_required: true
@@ -5161,7 +5161,7 @@ paths:
5161
5161
  source:
5162
5162
  payment_method:
5163
5163
  id: pm_UkLWZg9DAJ
5164
- name: Check
5164
+ name: Check 6
5165
5165
  description:
5166
5166
  type: check
5167
5167
  session_required: false
@@ -5326,8 +5326,8 @@ paths:
5326
5326
  preorder_ships_at:
5327
5327
  quantity: 1
5328
5328
  currency: USD
5329
- name: Product 3459789
5330
- slug: product-3459789
5329
+ name: Product 3469789
5330
+ slug: product-3469789
5331
5331
  options_text: ''
5332
5332
  price: '10.0'
5333
5333
  display_price: "$10.00"
@@ -5372,7 +5372,7 @@ paths:
5372
5372
  currency: USD
5373
5373
  payment_method:
5374
5374
  id: pm_UkLWZg9DAJ
5375
- name: Store Credit
5375
+ name: Store Credit 5
5376
5376
  description: Store Credit
5377
5377
  type: store_credit
5378
5378
  session_required: false
@@ -5381,7 +5381,7 @@ paths:
5381
5381
  shipping_address:
5382
5382
  payment_methods:
5383
5383
  - id: pm_UkLWZg9DAJ
5384
- name: Store Credit
5384
+ name: Store Credit 5
5385
5385
  description: Store Credit
5386
5386
  type: store_credit
5387
5387
  session_required: false
@@ -5544,8 +5544,8 @@ paths:
5544
5544
  preorder_ships_at:
5545
5545
  quantity: 1
5546
5546
  currency: USD
5547
- name: Product 347179
5548
- slug: product-347179
5547
+ name: Product 348179
5548
+ slug: product-348179
5549
5549
  options_text: ''
5550
5550
  price: '10.0'
5551
5551
  display_price: "$10.00"
@@ -5723,8 +5723,8 @@ paths:
5723
5723
  preorder_ships_at:
5724
5724
  quantity: 1
5725
5725
  currency: USD
5726
- name: Product 287496
5727
- slug: product-287496
5726
+ name: Product 288496
5727
+ slug: product-288496
5728
5728
  options_text: ''
5729
5729
  price: '10.0'
5730
5730
  display_price: "$10.00"
@@ -5787,8 +5787,8 @@ paths:
5787
5787
  delivered_at:
5788
5788
  delivery_method:
5789
5789
  id: dm_UkLWZg9DAJ
5790
- name: UPS Ground
5791
- code: UPS_GROUND
5790
+ name: UPS Ground 144
5791
+ code: UPS_GROUND_162
5792
5792
  estimated_transit_business_days_min:
5793
5793
  estimated_transit_business_days_max:
5794
5794
  digital: false
@@ -5809,7 +5809,7 @@ paths:
5809
5809
  delivery_rates:
5810
5810
  - id: dr_gbHJdmfrXB
5811
5811
  delivery_method_id: dm_UkLWZg9DAJ
5812
- name: UPS Ground
5812
+ name: UPS Ground 144
5813
5813
  selected: true
5814
5814
  cost: '10.0'
5815
5815
  total: '10.0'
@@ -5828,8 +5828,8 @@ paths:
5828
5828
  display_tax_total: "$0.00"
5829
5829
  delivery_method:
5830
5830
  id: dm_UkLWZg9DAJ
5831
- name: UPS Ground
5832
- code: UPS_GROUND
5831
+ name: UPS Ground 144
5832
+ code: UPS_GROUND_162
5833
5833
  estimated_transit_business_days_min:
5834
5834
  estimated_transit_business_days_max:
5835
5835
  digital: false
@@ -5842,7 +5842,7 @@ paths:
5842
5842
  first_name: John
5843
5843
  last_name: Doe
5844
5844
  full_name: John Doe
5845
- address1: 410 Lovely Street
5845
+ address1: 412 Lovely Street
5846
5846
  address2: Northwest
5847
5847
  postal_code: '10118'
5848
5848
  city: New York
@@ -5864,7 +5864,7 @@ paths:
5864
5864
  first_name: John
5865
5865
  last_name: Doe
5866
5866
  full_name: John Doe
5867
- address1: 411 Lovely Street
5867
+ address1: 413 Lovely Street
5868
5868
  address2: Northwest
5869
5869
  postal_code: '10118'
5870
5870
  city: New York
@@ -5970,7 +5970,7 @@ paths:
5970
5970
  first_name: John
5971
5971
  last_name: Doe
5972
5972
  full_name: John Doe
5973
- address1: 216 Lovely Street
5973
+ address1: 218 Lovely Street
5974
5974
  address2: Northwest
5975
5975
  postal_code: '10118'
5976
5976
  city: New York
@@ -5991,7 +5991,7 @@ paths:
5991
5991
  first_name: John
5992
5992
  last_name: Doe
5993
5993
  full_name: John Doe
5994
- address1: 217 Lovely Street
5994
+ address1: 219 Lovely Street
5995
5995
  address2: Northwest
5996
5996
  postal_code: '10118'
5997
5997
  city: New York
@@ -6012,7 +6012,7 @@ paths:
6012
6012
  first_name: John
6013
6013
  last_name: Doe
6014
6014
  full_name: John Doe
6015
- address1: 218 Lovely Street
6015
+ address1: 220 Lovely Street
6016
6016
  address2: Northwest
6017
6017
  postal_code: '10118'
6018
6018
  city: New York
@@ -6270,7 +6270,7 @@ paths:
6270
6270
  first_name: John
6271
6271
  last_name: Doe
6272
6272
  full_name: John Doe
6273
- address1: 230 Lovely Street
6273
+ address1: 232 Lovely Street
6274
6274
  address2: Northwest
6275
6275
  postal_code: '10118'
6276
6276
  city: New York
@@ -6352,7 +6352,7 @@ paths:
6352
6352
  first_name: John
6353
6353
  last_name: Doe
6354
6354
  full_name: John Doe
6355
- address1: 236 Lovely Street
6355
+ address1: 238 Lovely Street
6356
6356
  address2: Northwest
6357
6357
  postal_code: '10118'
6358
6358
  city: Los Angeles
@@ -6847,8 +6847,8 @@ paths:
6847
6847
  preorder_ships_at:
6848
6848
  quantity: 1
6849
6849
  currency: USD
6850
- name: Product 2525270
6851
- slug: product-2525270
6850
+ name: Product 2535270
6851
+ slug: product-2535270
6852
6852
  options_text: ''
6853
6853
  price: '10.0'
6854
6854
  display_price: "$10.00"
@@ -6911,8 +6911,8 @@ paths:
6911
6911
  delivered_at:
6912
6912
  delivery_method:
6913
6913
  id: dm_UkLWZg9DAJ
6914
- name: UPS Ground
6915
- code: UPS_GROUND
6914
+ name: UPS Ground 123
6915
+ code: UPS_GROUND_140
6916
6916
  estimated_transit_business_days_min:
6917
6917
  estimated_transit_business_days_max:
6918
6918
  digital: false
@@ -6933,7 +6933,7 @@ paths:
6933
6933
  delivery_rates:
6934
6934
  - id: dr_gbHJdmfrXB
6935
6935
  delivery_method_id: dm_UkLWZg9DAJ
6936
- name: UPS Ground
6936
+ name: UPS Ground 123
6937
6937
  selected: true
6938
6938
  cost: '10.0'
6939
6939
  total: '10.0'
@@ -6952,8 +6952,8 @@ paths:
6952
6952
  display_tax_total: "$0.00"
6953
6953
  delivery_method:
6954
6954
  id: dm_UkLWZg9DAJ
6955
- name: UPS Ground
6956
- code: UPS_GROUND
6955
+ name: UPS Ground 123
6956
+ code: UPS_GROUND_140
6957
6957
  estimated_transit_business_days_min:
6958
6958
  estimated_transit_business_days_max:
6959
6959
  digital: false
@@ -6966,7 +6966,7 @@ paths:
6966
6966
  first_name: John
6967
6967
  last_name: Doe
6968
6968
  full_name: John Doe
6969
- address1: 302 Lovely Street
6969
+ address1: 304 Lovely Street
6970
6970
  address2: Northwest
6971
6971
  postal_code: '10118'
6972
6972
  city: New York
@@ -6988,7 +6988,7 @@ paths:
6988
6988
  first_name: John
6989
6989
  last_name: Doe
6990
6990
  full_name: John Doe
6991
- address1: 303 Lovely Street
6991
+ address1: 305 Lovely Street
6992
6992
  address2: Northwest
6993
6993
  postal_code: '10118'
6994
6994
  city: New York
@@ -7169,8 +7169,8 @@ paths:
7169
7169
  preorder_ships_at:
7170
7170
  quantity: 1
7171
7171
  currency: USD
7172
- name: Product 2545633
7173
- slug: product-2545633
7172
+ name: Product 2555633
7173
+ slug: product-2555633
7174
7174
  options_text: ''
7175
7175
  price: '10.0'
7176
7176
  display_price: "$10.00"
@@ -7233,8 +7233,8 @@ paths:
7233
7233
  delivered_at:
7234
7234
  delivery_method:
7235
7235
  id: dm_UkLWZg9DAJ
7236
- name: UPS Ground
7237
- code: UPS_GROUND
7236
+ name: UPS Ground 125
7237
+ code: UPS_GROUND_142
7238
7238
  estimated_transit_business_days_min:
7239
7239
  estimated_transit_business_days_max:
7240
7240
  digital: false
@@ -7255,7 +7255,7 @@ paths:
7255
7255
  delivery_rates:
7256
7256
  - id: dr_gbHJdmfrXB
7257
7257
  delivery_method_id: dm_UkLWZg9DAJ
7258
- name: UPS Ground
7258
+ name: UPS Ground 125
7259
7259
  selected: true
7260
7260
  cost: '10.0'
7261
7261
  total: '10.0'
@@ -7274,8 +7274,8 @@ paths:
7274
7274
  display_tax_total: "$0.00"
7275
7275
  delivery_method:
7276
7276
  id: dm_UkLWZg9DAJ
7277
- name: UPS Ground
7278
- code: UPS_GROUND
7277
+ name: UPS Ground 125
7278
+ code: UPS_GROUND_142
7279
7279
  estimated_transit_business_days_min:
7280
7280
  estimated_transit_business_days_max:
7281
7281
  digital: false
@@ -7288,7 +7288,7 @@ paths:
7288
7288
  first_name: John
7289
7289
  last_name: Doe
7290
7290
  full_name: John Doe
7291
- address1: 308 Lovely Street
7291
+ address1: 310 Lovely Street
7292
7292
  address2: Northwest
7293
7293
  postal_code: '10118'
7294
7294
  city: New York
@@ -7310,7 +7310,7 @@ paths:
7310
7310
  first_name: John
7311
7311
  last_name: Doe
7312
7312
  full_name: John Doe
7313
- address1: 309 Lovely Street
7313
+ address1: 311 Lovely Street
7314
7314
  address2: Northwest
7315
7315
  postal_code: '10118'
7316
7316
  city: New York
@@ -7516,7 +7516,7 @@ paths:
7516
7516
  application/json:
7517
7517
  example:
7518
7518
  id: cust_UkLWZg9DAJ
7519
- email: rochell_kihn@wolf.name
7519
+ email: rochell@schoen.name
7520
7520
  first_name: Felix
7521
7521
  last_name: Rowe
7522
7522
  phone: 555-555-0199
@@ -7531,7 +7531,7 @@ paths:
7531
7531
  first_name: John
7532
7532
  last_name: Doe
7533
7533
  full_name: John Doe
7534
- address1: 314 Lovely Street
7534
+ address1: 316 Lovely Street
7535
7535
  address2: Northwest
7536
7536
  postal_code: '10118'
7537
7537
  city: New York
@@ -7552,7 +7552,7 @@ paths:
7552
7552
  first_name: John
7553
7553
  last_name: Doe
7554
7554
  full_name: John Doe
7555
- address1: 315 Lovely Street
7555
+ address1: 317 Lovely Street
7556
7556
  address2: Northwest
7557
7557
  postal_code: '10118'
7558
7558
  city: New York
@@ -7574,7 +7574,7 @@ paths:
7574
7574
  first_name: John
7575
7575
  last_name: Doe
7576
7576
  full_name: John Doe
7577
- address1: 315 Lovely Street
7577
+ address1: 317 Lovely Street
7578
7578
  address2: Northwest
7579
7579
  postal_code: '10118'
7580
7580
  city: New York
@@ -7596,7 +7596,7 @@ paths:
7596
7596
  first_name: John
7597
7597
  last_name: Doe
7598
7598
  full_name: John Doe
7599
- address1: 314 Lovely Street
7599
+ address1: 316 Lovely Street
7600
7600
  address2: Northwest
7601
7601
  postal_code: '10118'
7602
7602
  city: New York
@@ -7673,7 +7673,7 @@ paths:
7673
7673
  application/json:
7674
7674
  example:
7675
7675
  id: cust_UkLWZg9DAJ
7676
- email: tabitha_rosenbaum@ziemebogisich.info
7676
+ email: tabitha@ziemebogisich.info
7677
7677
  first_name: Updated
7678
7678
  last_name: Name
7679
7679
  phone: 555-555-0199
@@ -7688,7 +7688,7 @@ paths:
7688
7688
  first_name: John
7689
7689
  last_name: Doe
7690
7690
  full_name: John Doe
7691
- address1: 316 Lovely Street
7691
+ address1: 318 Lovely Street
7692
7692
  address2: Northwest
7693
7693
  postal_code: '10118'
7694
7694
  city: New York
@@ -7709,7 +7709,7 @@ paths:
7709
7709
  first_name: John
7710
7710
  last_name: Doe
7711
7711
  full_name: John Doe
7712
- address1: 317 Lovely Street
7712
+ address1: 319 Lovely Street
7713
7713
  address2: Northwest
7714
7714
  postal_code: '10118'
7715
7715
  city: New York
@@ -7731,7 +7731,7 @@ paths:
7731
7731
  first_name: John
7732
7732
  last_name: Doe
7733
7733
  full_name: John Doe
7734
- address1: 317 Lovely Street
7734
+ address1: 319 Lovely Street
7735
7735
  address2: Northwest
7736
7736
  postal_code: '10118'
7737
7737
  city: New York
@@ -7753,7 +7753,7 @@ paths:
7753
7753
  first_name: John
7754
7754
  last_name: Doe
7755
7755
  full_name: John Doe
7756
- address1: 316 Lovely Street
7756
+ address1: 318 Lovely Street
7757
7757
  address2: Northwest
7758
7758
  postal_code: '10118'
7759
7759
  city: New York
@@ -8243,7 +8243,7 @@ paths:
8243
8243
  customer_id: cust_UkLWZg9DAJ
8244
8244
  payment_method:
8245
8245
  id: pm_UkLWZg9DAJ
8246
- name: Credit Card
8246
+ name: Credit Card 127
8247
8247
  description:
8248
8248
  type: bogus
8249
8249
  session_required: true
@@ -8344,7 +8344,7 @@ paths:
8344
8344
  customer_id: cust_UkLWZg9DAJ
8345
8345
  payment_method:
8346
8346
  id: pm_UkLWZg9DAJ
8347
- name: Credit Card
8347
+ name: Credit Card 130
8348
8348
  description:
8349
8349
  type: bogus
8350
8350
  session_required: true
@@ -8425,7 +8425,7 @@ paths:
8425
8425
  customer_id: cust_UkLWZg9DAJ
8426
8426
  payment_method:
8427
8427
  id: pm_UkLWZg9DAJ
8428
- name: Credit Card
8428
+ name: Credit Card 132
8429
8429
  description:
8430
8430
  type: bogus
8431
8431
  session_required: true
@@ -9732,7 +9732,7 @@ paths:
9732
9732
  variant:
9733
9733
  id: variant_gbHJdmfrXB
9734
9734
  product_id: prod_gbHJdmfrXB
9735
- sku: SKU-435
9735
+ sku: SKU-436
9736
9736
  options_text: ''
9737
9737
  track_inventory: true
9738
9738
  media_count: 0
@@ -9905,7 +9905,7 @@ paths:
9905
9905
  application/json:
9906
9906
  example:
9907
9907
  id: sub_UkLWZg9DAJ
9908
- email: marth.carter@halvorsonlind.ca
9908
+ email: phung.sawayn@carterfunk.ca
9909
9909
  created_at: '2026-01-15T12:00:00.000Z'
9910
9910
  updated_at: '2026-01-15T12:00:00.000Z'
9911
9911
  verified: true
@@ -10663,7 +10663,7 @@ paths:
10663
10663
  first_name:
10664
10664
  last_name:
10665
10665
  full_name: ''
10666
- address1: 275 Lovely Street
10666
+ address1: 277 Lovely Street
10667
10667
  address2: Northwest
10668
10668
  postal_code: '10118'
10669
10669
  city: New York
@@ -10734,7 +10734,7 @@ paths:
10734
10734
  first_name:
10735
10735
  last_name:
10736
10736
  full_name: ''
10737
- address1: 278 Lovely Street
10737
+ address1: 280 Lovely Street
10738
10738
  address2: Northwest
10739
10739
  postal_code: '10118'
10740
10740
  city: New York
@@ -10913,8 +10913,8 @@ paths:
10913
10913
  preorder_ships_at:
10914
10914
  quantity: 1
10915
10915
  currency: USD
10916
- name: Product 2515649
10917
- slug: product-2515649
10916
+ name: Product 2525649
10917
+ slug: product-2525649
10918
10918
  options_text: ''
10919
10919
  price: '10.0'
10920
10920
  display_price: "$10.00"
@@ -10977,8 +10977,8 @@ paths:
10977
10977
  delivered_at:
10978
10978
  delivery_method:
10979
10979
  id: dm_UkLWZg9DAJ
10980
- name: UPS Ground
10981
- code: UPS_GROUND
10980
+ name: UPS Ground 114
10981
+ code: UPS_GROUND_131
10982
10982
  estimated_transit_business_days_min:
10983
10983
  estimated_transit_business_days_max:
10984
10984
  digital: false
@@ -10999,7 +10999,7 @@ paths:
10999
10999
  delivery_rates:
11000
11000
  - id: dr_gbHJdmfrXB
11001
11001
  delivery_method_id: dm_UkLWZg9DAJ
11002
- name: UPS Ground
11002
+ name: UPS Ground 114
11003
11003
  selected: true
11004
11004
  cost: '10.0'
11005
11005
  total: '10.0'
@@ -11018,8 +11018,8 @@ paths:
11018
11018
  display_tax_total: "$0.00"
11019
11019
  delivery_method:
11020
11020
  id: dm_UkLWZg9DAJ
11021
- name: UPS Ground
11022
- code: UPS_GROUND
11021
+ name: UPS Ground 114
11022
+ code: UPS_GROUND_131
11023
11023
  estimated_transit_business_days_min:
11024
11024
  estimated_transit_business_days_max:
11025
11025
  digital: false
@@ -11032,7 +11032,7 @@ paths:
11032
11032
  first_name: John
11033
11033
  last_name: Doe
11034
11034
  full_name: John Doe
11035
- address1: 286 Lovely Street
11035
+ address1: 288 Lovely Street
11036
11036
  address2: Northwest
11037
11037
  postal_code: '10118'
11038
11038
  city: New York
@@ -11054,7 +11054,7 @@ paths:
11054
11054
  first_name: John
11055
11055
  last_name: Doe
11056
11056
  full_name: John Doe
11057
- address1: 287 Lovely Street
11057
+ address1: 289 Lovely Street
11058
11058
  address2: Northwest
11059
11059
  postal_code: '10118'
11060
11060
  city: New York
@@ -11251,7 +11251,7 @@ paths:
11251
11251
  data:
11252
11252
  - id: dm_gbHJdmfrXB
11253
11253
  name: Store pickup
11254
- code: PICKUP
11254
+ code: PICKUP_1
11255
11255
  estimated_transit_business_days_min:
11256
11256
  estimated_transit_business_days_max:
11257
11257
  digital: false
package/dist/developer/core-concepts/reporting.md CHANGED
@@ -189,7 +189,7 @@ beside metrics and dimensions, and `GET /dashboard/counters` evaluates them:
189
189
  "nav": "orders",
190
190
  "link": {
191
191
  "resource": "orders",
192
- "filters": [{ "field": "fulfillment_status", "operator": "eq", "value": "unfulfilled" }]
192
+ "filters": [{ "field": "fulfillment_status", "operator": "in", "value": "unfulfilled" }]
193
193
  }
194
194
  }
195
195
  ]
package/dist/developer/upgrades/5.6-to-6.0.md CHANGED
@@ -138,6 +138,22 @@ bundle exec rake spree:stock:recount_levels
138
138
 
139
139
  `spree_stock_levels` gains `reserved_count` (units held by checkouts in progress) and `incoming_count` (units on their way on a purchase order placed with a supplier or a transfer in transit). Both are kept by the workflows that change them and start at zero on an existing install; this recomputes them from active reservations and open documents and prints every level it corrected. Until it runs, the dashboard's Inventory page shows zero reserved and incoming for stock that predates the upgrade. Safe to re-run at any time.
140
140
 
141
+ ### Name who performed past actions
142
+
143
+ ```bash
144
+ bundle exec rake spree:upgrade:backfill_actor_types
145
+ ```
146
+
147
+ Orders, refunds, returns, exchanges, claims and stock receipts remember who
148
+ cancelled, approved, created or received them. In 6.0 that can be a member of
149
+ staff **or an API key**, so each id column — `canceler_id`, `approver_id`,
150
+ `created_by_id`, `refunder_id`, `received_by_id` — gained a type column beside
151
+ it (`canceler_type`, and so on) naming which kind of actor the id points at.
152
+
153
+ Rows written before the upgrade carry an id and an empty type; this task fills
154
+ the type in. Until it runs they still read as the staff member they always
155
+ were, with a deprecation warning. Safe to re-run at any time.
156
+
141
157
  ## The Cart/Order split
142
158
 
143
159
  The single biggest change. What used to be one `Spree::Order` living through checkout and beyond is now two models:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spree/docs",
3
- "version": "0.1.235",
3
+ "version": "0.1.237",
4
4
  "description": "Spree Commerce developer documentation for AI agents and local reference",
5
5
  "type": "module",
6
6
  "license": "CC-BY-4.0",