@spree/docs 0.1.180 → 0.1.181

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.
@@ -1051,8 +1051,8 @@ paths:
1051
1051
  example:
1052
1052
  data:
1053
1053
  - id: prod_UkLWZg9DAJ
1054
- name: Product 2029085
1055
- slug: product-2029085
1054
+ name: Product 2039085
1055
+ slug: product-2039085
1056
1056
  meta_title:
1057
1057
  meta_description:
1058
1058
  meta_keywords:
@@ -1083,8 +1083,8 @@ paths:
1083
1083
  original_price:
1084
1084
  seller_id:
1085
1085
  - id: prod_gbHJdmfrXB
1086
- name: Product 2038209
1087
- slug: product-2038209
1086
+ name: Product 2048209
1087
+ slug: product-2048209
1088
1088
  meta_title:
1089
1089
  meta_description:
1090
1090
  meta_keywords:
@@ -1212,8 +1212,8 @@ paths:
1212
1212
  application/json:
1213
1213
  example:
1214
1214
  id: prod_UkLWZg9DAJ
1215
- name: Product 2306885
1216
- slug: product-2306885
1215
+ name: Product 2316885
1216
+ slug: product-2316885
1217
1217
  meta_title:
1218
1218
  meta_description:
1219
1219
  meta_keywords:
@@ -1498,6 +1498,8 @@ paths:
1498
1498
  market_id: mkt_UkLWZg9DAJ
1499
1499
  channel_id: ch_UkLWZg9DAJ
1500
1500
  preferred_stock_location_id:
1501
+ company_id:
1502
+ company_name:
1501
1503
  number: cart_UkLWZg9DAJ
1502
1504
  token: ckMf2iQ6r5adLceTPfKVH9BP
1503
1505
  email:
@@ -1607,6 +1609,8 @@ paths:
1607
1609
  market_id: mkt_UkLWZg9DAJ
1608
1610
  channel_id: ch_UkLWZg9DAJ
1609
1611
  preferred_stock_location_id:
1612
+ company_id:
1613
+ company_name:
1610
1614
  number: cart_gbHJdmfrXB
1611
1615
  token: pvLw1ZWLLQNxh1uvSPUCdSmt
1612
1616
  email:
@@ -1787,6 +1791,8 @@ paths:
1787
1791
  market_id: mkt_UkLWZg9DAJ
1788
1792
  channel_id: ch_UkLWZg9DAJ
1789
1793
  preferred_stock_location_id:
1794
+ company_id:
1795
+ company_name:
1790
1796
  number: cart_UkLWZg9DAJ
1791
1797
  token: jBrNbC8FSNyavqebdqu7e3uL
1792
1798
  email:
@@ -1955,6 +1961,8 @@ paths:
1955
1961
  market_id: mkt_UkLWZg9DAJ
1956
1962
  channel_id: ch_UkLWZg9DAJ
1957
1963
  preferred_stock_location_id:
1964
+ company_id:
1965
+ company_name:
1958
1966
  number: cart_UkLWZg9DAJ
1959
1967
  token: HnnryvFFwjfx9P6ykByF4Gg2
1960
1968
  email:
@@ -2112,6 +2120,8 @@ paths:
2112
2120
  market_id: mkt_UkLWZg9DAJ
2113
2121
  channel_id: ch_UkLWZg9DAJ
2114
2122
  preferred_stock_location_id:
2123
+ company_id:
2124
+ company_name:
2115
2125
  number: cart_UkLWZg9DAJ
2116
2126
  token: PMVmxRAiLqMivU5QgJqfpQMD
2117
2127
  email:
@@ -2391,6 +2401,8 @@ paths:
2391
2401
  market_id: mkt_UkLWZg9DAJ
2392
2402
  channel_id: ch_UkLWZg9DAJ
2393
2403
  preferred_stock_location_id:
2404
+ company_id:
2405
+ company_name:
2394
2406
  number: cart_UkLWZg9DAJ
2395
2407
  token: rrGvkDXx3KcQVwLVk8XiVCVk
2396
2408
  email: tarah@tromp.com
@@ -2476,6 +2488,7 @@ paths:
2476
2488
  payments: []
2477
2489
  billing_address:
2478
2490
  id: addr_gbHJdmfrXB
2491
+ label:
2479
2492
  first_name: John
2480
2493
  last_name: Doe
2481
2494
  full_name: John Doe
@@ -2497,6 +2510,7 @@ paths:
2497
2510
  state_name: New York
2498
2511
  shipping_address:
2499
2512
  id: addr_UkLWZg9DAJ
2513
+ label:
2500
2514
  first_name: John
2501
2515
  last_name: Doe
2502
2516
  full_name: John Doe
@@ -2607,6 +2621,8 @@ paths:
2607
2621
  market_id: mkt_UkLWZg9DAJ
2608
2622
  cart_id: cart_UkLWZg9DAJ
2609
2623
  channel_id: ch_UkLWZg9DAJ
2624
+ company_id:
2625
+ company_name:
2610
2626
  number: R1001
2611
2627
  email: marvel@bruen.com
2612
2628
  customer_note:
@@ -2783,6 +2799,7 @@ paths:
2783
2799
  source_required: false
2784
2800
  billing_address:
2785
2801
  id: addr_uw2YK1rnl0
2802
+ label:
2786
2803
  first_name: John
2787
2804
  last_name: Doe
2788
2805
  full_name: John Doe
@@ -2804,6 +2821,7 @@ paths:
2804
2821
  state_name: New York
2805
2822
  shipping_address:
2806
2823
  id: addr_OIJLhNcSbf
2824
+ label:
2807
2825
  first_name: John
2808
2826
  last_name: Doe
2809
2827
  full_name: John Doe
@@ -2918,6 +2936,8 @@ paths:
2918
2936
  market_id: mkt_UkLWZg9DAJ
2919
2937
  channel_id: ch_UkLWZg9DAJ
2920
2938
  preferred_stock_location_id:
2939
+ company_id:
2940
+ company_name:
2921
2941
  number: cart_UkLWZg9DAJ
2922
2942
  token: 4ryA4ms4Nim9TfxNW4fZi3au
2923
2943
  email:
@@ -2981,8 +3001,8 @@ paths:
2981
3001
  preorder_ships_at:
2982
3002
  quantity: 1
2983
3003
  currency: USD
2984
- name: Product 1684241
2985
- slug: product-1684241
3004
+ name: Product 1694241
3005
+ slug: product-1694241
2986
3006
  options_text: ''
2987
3007
  price: '10.0'
2988
3008
  display_price: "$10.00"
@@ -3110,6 +3130,8 @@ paths:
3110
3130
  market_id: mkt_UkLWZg9DAJ
3111
3131
  channel_id: ch_UkLWZg9DAJ
3112
3132
  preferred_stock_location_id:
3133
+ company_id:
3134
+ company_name:
3113
3135
  number: cart_UkLWZg9DAJ
3114
3136
  token: gvr8TwNVJpxWf27uUHDj5Lj4
3115
3137
  email:
@@ -3170,8 +3192,8 @@ paths:
3170
3192
  preorder_ships_at:
3171
3193
  quantity: 1
3172
3194
  currency: USD
3173
- name: Product 1703461
3174
- slug: product-1703461
3195
+ name: Product 1713461
3196
+ slug: product-1713461
3175
3197
  options_text: ''
3176
3198
  price: '10.0'
3177
3199
  display_price: "$10.00"
@@ -3293,6 +3315,8 @@ paths:
3293
3315
  market_id: mkt_UkLWZg9DAJ
3294
3316
  channel_id: ch_UkLWZg9DAJ
3295
3317
  preferred_stock_location_id:
3318
+ company_id:
3319
+ company_name:
3296
3320
  number: cart_UkLWZg9DAJ
3297
3321
  token: KLLfFWg9T6dGonBb65hHjaZr
3298
3322
  email: donya@jacobsonkunze.biz
@@ -3347,8 +3371,8 @@ paths:
3347
3371
  preorder_ships_at:
3348
3372
  quantity: 1
3349
3373
  currency: USD
3350
- name: Product 1728182
3351
- slug: product-1728182
3374
+ name: Product 1738182
3375
+ slug: product-1738182
3352
3376
  options_text: ''
3353
3377
  price: '10.0'
3354
3378
  display_price: "$10.00"
@@ -3454,10 +3478,11 @@ paths:
3454
3478
  billing_address:
3455
3479
  shipping_address:
3456
3480
  id: addr_EfhxLZ9ck8
3481
+ label:
3457
3482
  first_name: John
3458
3483
  last_name: Doe
3459
3484
  full_name: John Doe
3460
- address1: 199 Lovely Street
3485
+ address1: 226 Lovely Street
3461
3486
  address2: Northwest
3462
3487
  postal_code: '10118'
3463
3488
  city: New York
@@ -3577,6 +3602,8 @@ paths:
3577
3602
  market_id: mkt_UkLWZg9DAJ
3578
3603
  channel_id: ch_UkLWZg9DAJ
3579
3604
  preferred_stock_location_id:
3605
+ company_id:
3606
+ company_name:
3580
3607
  number: cart_UkLWZg9DAJ
3581
3608
  token: nZjAPYSKrNaHf2ZVT6eZfNJV
3582
3609
  email:
@@ -3633,8 +3660,8 @@ paths:
3633
3660
  preorder_ships_at:
3634
3661
  quantity: 1
3635
3662
  currency: USD
3636
- name: Product 1745702
3637
- slug: product-1745702
3663
+ name: Product 1755702
3664
+ slug: product-1755702
3638
3665
  options_text: ''
3639
3666
  price: '10.0'
3640
3667
  display_price: "$10.00"
@@ -3817,6 +3844,8 @@ paths:
3817
3844
  market_id: mkt_UkLWZg9DAJ
3818
3845
  channel_id: ch_UkLWZg9DAJ
3819
3846
  preferred_stock_location_id:
3847
+ company_id:
3848
+ company_name:
3820
3849
  number: cart_UkLWZg9DAJ
3821
3850
  token: Wgq8NrLX3TUQLroJRYWFdQd5
3822
3851
  email:
@@ -3877,8 +3906,8 @@ paths:
3877
3906
  preorder_ships_at:
3878
3907
  quantity: 1
3879
3908
  currency: USD
3880
- name: Product 1789569
3881
- slug: product-1789569
3909
+ name: Product 1799569
3910
+ slug: product-1799569
3882
3911
  options_text: ''
3883
3912
  price: '10.0'
3884
3913
  display_price: "$10.00"
@@ -4016,6 +4045,8 @@ paths:
4016
4045
  market_id: mkt_UkLWZg9DAJ
4017
4046
  channel_id: ch_UkLWZg9DAJ
4018
4047
  preferred_stock_location_id:
4048
+ company_id:
4049
+ company_name:
4019
4050
  number: cart_UkLWZg9DAJ
4020
4051
  token: d12LXVnL3KtzGjXePqRawnPc
4021
4052
  email:
@@ -4025,10 +4056,10 @@ paths:
4025
4056
  total_quantity: 2
4026
4057
  warnings:
4027
4058
  - code: delivery_unavailable
4028
- message: Product 18163 cannot be delivered to the selected address
4059
+ message: Product 18263 cannot be delivered to the selected address
4029
4060
  line_item_id: li_UkLWZg9DAJ
4030
4061
  - code: delivery_unavailable
4031
- message: Product 182298 cannot be delivered to the selected address
4062
+ message: Product 183298 cannot be delivered to the selected address
4032
4063
  line_item_id: li_gbHJdmfrXB
4033
4064
  coupon_code:
4034
4065
  item_total: '29.99'
@@ -4082,8 +4113,8 @@ paths:
4082
4113
  preorder_ships_at:
4083
4114
  quantity: 1
4084
4115
  currency: USD
4085
- name: Product 18163
4086
- slug: product-18163
4116
+ name: Product 18263
4117
+ slug: product-18263
4087
4118
  options_text: ''
4088
4119
  price: '10.0'
4089
4120
  display_price: "$10.00"
@@ -4113,8 +4144,8 @@ paths:
4113
4144
  preorder_ships_at:
4114
4145
  quantity: 1
4115
4146
  currency: USD
4116
- name: Product 182298
4117
- slug: product-182298
4147
+ name: Product 183298
4148
+ slug: product-183298
4118
4149
  options_text: ''
4119
4150
  price: '19.99'
4120
4151
  display_price: "$19.99"
@@ -4269,6 +4300,8 @@ paths:
4269
4300
  market_id: mkt_UkLWZg9DAJ
4270
4301
  channel_id: ch_UkLWZg9DAJ
4271
4302
  preferred_stock_location_id:
4303
+ company_id:
4304
+ company_name:
4272
4305
  number: cart_UkLWZg9DAJ
4273
4306
  token: Yq5XuZqq7KS7y7n2dMsChnZM
4274
4307
  email:
@@ -4333,8 +4366,8 @@ paths:
4333
4366
  preorder_ships_at:
4334
4367
  quantity: 1
4335
4368
  currency: USD
4336
- name: Product 1889165
4337
- slug: product-1889165
4369
+ name: Product 1899165
4370
+ slug: product-1899165
4338
4371
  options_text: ''
4339
4372
  price: '10.0'
4340
4373
  display_price: "$10.00"
@@ -4451,6 +4484,8 @@ paths:
4451
4484
  market_id: mkt_UkLWZg9DAJ
4452
4485
  channel_id: ch_UkLWZg9DAJ
4453
4486
  preferred_stock_location_id:
4487
+ company_id:
4488
+ company_name:
4454
4489
  number: cart_UkLWZg9DAJ
4455
4490
  token: arTvbVzmU1krWKLbRnWDZ3cL
4456
4491
  email:
@@ -5087,6 +5122,8 @@ paths:
5087
5122
  market_id: mkt_UkLWZg9DAJ
5088
5123
  channel_id: ch_UkLWZg9DAJ
5089
5124
  preferred_stock_location_id:
5125
+ company_id:
5126
+ company_name:
5090
5127
  number: cart_UkLWZg9DAJ
5091
5128
  token: acfBZtWemHae74Y3g18LQg1f
5092
5129
  email:
@@ -5143,8 +5180,8 @@ paths:
5143
5180
  preorder_ships_at:
5144
5181
  quantity: 1
5145
5182
  currency: USD
5146
- name: Product 2509789
5147
- slug: product-2509789
5183
+ name: Product 2519789
5184
+ slug: product-2519789
5148
5185
  options_text: ''
5149
5186
  price: '10.0'
5150
5187
  display_price: "$10.00"
@@ -5291,6 +5328,8 @@ paths:
5291
5328
  market_id: mkt_UkLWZg9DAJ
5292
5329
  channel_id: ch_UkLWZg9DAJ
5293
5330
  preferred_stock_location_id:
5331
+ company_id:
5332
+ company_name:
5294
5333
  number: cart_UkLWZg9DAJ
5295
5334
  token: BHWevnp2PQxC1jSWU3ZFLejT
5296
5335
  email:
@@ -5351,8 +5390,8 @@ paths:
5351
5390
  preorder_ships_at:
5352
5391
  quantity: 1
5353
5392
  currency: USD
5354
- name: Product 252179
5355
- slug: product-252179
5393
+ name: Product 253179
5394
+ slug: product-253179
5356
5395
  options_text: ''
5357
5396
  price: '10.0'
5358
5397
  display_price: "$10.00"
@@ -5471,6 +5510,8 @@ paths:
5471
5510
  market_id: mkt_UkLWZg9DAJ
5472
5511
  cart_id:
5473
5512
  channel_id: ch_UkLWZg9DAJ
5513
+ company_id:
5514
+ company_name:
5474
5515
  number: R1001
5475
5516
  email: guest@example.com
5476
5517
  customer_note:
@@ -5516,8 +5557,8 @@ paths:
5516
5557
  preorder_ships_at:
5517
5558
  quantity: 1
5518
5559
  currency: USD
5519
- name: Product 192496
5520
- slug: product-192496
5560
+ name: Product 193496
5561
+ slug: product-193496
5521
5562
  options_text: ''
5522
5563
  price: '10.0'
5523
5564
  display_price: "$10.00"
@@ -5622,10 +5663,11 @@ paths:
5622
5663
  payments: []
5623
5664
  billing_address:
5624
5665
  id: addr_UkLWZg9DAJ
5666
+ label:
5625
5667
  first_name: John
5626
5668
  last_name: Doe
5627
5669
  full_name: John Doe
5628
- address1: 255 Lovely Street
5670
+ address1: 282 Lovely Street
5629
5671
  address2: Northwest
5630
5672
  postal_code: '10118'
5631
5673
  city: New York
@@ -5643,10 +5685,11 @@ paths:
5643
5685
  state_name: New York
5644
5686
  shipping_address:
5645
5687
  id: addr_gbHJdmfrXB
5688
+ label:
5646
5689
  first_name: John
5647
5690
  last_name: Doe
5648
5691
  full_name: John Doe
5649
- address1: 256 Lovely Street
5692
+ address1: 283 Lovely Street
5650
5693
  address2: Northwest
5651
5694
  postal_code: '10118'
5652
5695
  city: New York
@@ -5748,6 +5791,7 @@ paths:
5748
5791
  example:
5749
5792
  data:
5750
5793
  - id: addr_UkLWZg9DAJ
5794
+ label:
5751
5795
  first_name: John
5752
5796
  last_name: Doe
5753
5797
  full_name: John Doe
@@ -5768,6 +5812,7 @@ paths:
5768
5812
  country_iso: US
5769
5813
  state_name: New York
5770
5814
  - id: addr_gbHJdmfrXB
5815
+ label:
5771
5816
  first_name: John
5772
5817
  last_name: Doe
5773
5818
  full_name: John Doe
@@ -5788,6 +5833,7 @@ paths:
5788
5833
  country_iso: US
5789
5834
  state_name: New York
5790
5835
  - id: addr_EfhxLZ9ck8
5836
+ label:
5791
5837
  first_name: John
5792
5838
  last_name: Doe
5793
5839
  full_name: John Doe
@@ -5888,6 +5934,7 @@ paths:
5888
5934
  application/json:
5889
5935
  example:
5890
5936
  id: addr_VqXmZF31wY
5937
+ label:
5891
5938
  first_name: John
5892
5939
  last_name: Doe
5893
5940
  full_name: John Doe
@@ -6044,6 +6091,7 @@ paths:
6044
6091
  application/json:
6045
6092
  example:
6046
6093
  id: addr_EfhxLZ9ck8
6094
+ label:
6047
6095
  first_name: John
6048
6096
  last_name: Doe
6049
6097
  full_name: John Doe
@@ -6125,6 +6173,7 @@ paths:
6125
6173
  application/json:
6126
6174
  example:
6127
6175
  id: addr_EfhxLZ9ck8
6176
+ label:
6128
6177
  first_name: John
6129
6178
  last_name: Doe
6130
6179
  full_name: John Doe
@@ -6571,6 +6620,8 @@ paths:
6571
6620
  market_id: mkt_UkLWZg9DAJ
6572
6621
  cart_id:
6573
6622
  channel_id: ch_UkLWZg9DAJ
6623
+ company_id:
6624
+ company_name:
6574
6625
  number: R1001
6575
6626
  email: idella.ratke@runolfsdottir.us
6576
6627
  customer_note:
@@ -6616,8 +6667,8 @@ paths:
6616
6667
  preorder_ships_at:
6617
6668
  quantity: 1
6618
6669
  currency: USD
6619
- name: Product 1585270
6620
- slug: product-1585270
6670
+ name: Product 1595270
6671
+ slug: product-1595270
6621
6672
  options_text: ''
6622
6673
  price: '10.0'
6623
6674
  display_price: "$10.00"
@@ -6722,10 +6773,11 @@ paths:
6722
6773
  payments: []
6723
6774
  billing_address:
6724
6775
  id: addr_EfhxLZ9ck8
6776
+ label:
6725
6777
  first_name: John
6726
6778
  last_name: Doe
6727
6779
  full_name: John Doe
6728
- address1: 159 Lovely Street
6780
+ address1: 186 Lovely Street
6729
6781
  address2: Northwest
6730
6782
  postal_code: '10118'
6731
6783
  city: New York
@@ -6743,10 +6795,11 @@ paths:
6743
6795
  state_name: New York
6744
6796
  shipping_address:
6745
6797
  id: addr_VqXmZF31wY
6798
+ label:
6746
6799
  first_name: John
6747
6800
  last_name: Doe
6748
6801
  full_name: John Doe
6749
- address1: 160 Lovely Street
6802
+ address1: 187 Lovely Street
6750
6803
  address2: Northwest
6751
6804
  postal_code: '10118'
6752
6805
  city: New York
@@ -6875,6 +6928,8 @@ paths:
6875
6928
  market_id: mkt_UkLWZg9DAJ
6876
6929
  cart_id:
6877
6930
  channel_id: ch_UkLWZg9DAJ
6931
+ company_id:
6932
+ company_name:
6878
6933
  number: R1001
6879
6934
  email: whitney_homenick@leschwhite.co.uk
6880
6935
  customer_note:
@@ -6920,8 +6975,8 @@ paths:
6920
6975
  preorder_ships_at:
6921
6976
  quantity: 1
6922
6977
  currency: USD
6923
- name: Product 1605633
6924
- slug: product-1605633
6978
+ name: Product 1615633
6979
+ slug: product-1615633
6925
6980
  options_text: ''
6926
6981
  price: '10.0'
6927
6982
  display_price: "$10.00"
@@ -7026,10 +7081,11 @@ paths:
7026
7081
  payments: []
7027
7082
  billing_address:
7028
7083
  id: addr_EfhxLZ9ck8
7084
+ label:
7029
7085
  first_name: John
7030
7086
  last_name: Doe
7031
7087
  full_name: John Doe
7032
- address1: 165 Lovely Street
7088
+ address1: 192 Lovely Street
7033
7089
  address2: Northwest
7034
7090
  postal_code: '10118'
7035
7091
  city: New York
@@ -7047,10 +7103,11 @@ paths:
7047
7103
  state_name: New York
7048
7104
  shipping_address:
7049
7105
  id: addr_VqXmZF31wY
7106
+ label:
7050
7107
  first_name: John
7051
7108
  last_name: Doe
7052
7109
  full_name: John Doe
7053
- address1: 166 Lovely Street
7110
+ address1: 193 Lovely Street
7054
7111
  address2: Northwest
7055
7112
  postal_code: '10118'
7056
7113
  city: New York
@@ -7265,10 +7322,11 @@ paths:
7265
7322
  display_available_store_credit_total: "$0.00"
7266
7323
  addresses:
7267
7324
  - id: addr_UkLWZg9DAJ
7325
+ label:
7268
7326
  first_name: John
7269
7327
  last_name: Doe
7270
7328
  full_name: John Doe
7271
- address1: 171 Lovely Street
7329
+ address1: 198 Lovely Street
7272
7330
  address2: Northwest
7273
7331
  postal_code: '10118'
7274
7332
  city: New York
@@ -7285,10 +7343,11 @@ paths:
7285
7343
  country_iso: US
7286
7344
  state_name: New York
7287
7345
  - id: addr_gbHJdmfrXB
7346
+ label:
7288
7347
  first_name: John
7289
7348
  last_name: Doe
7290
7349
  full_name: John Doe
7291
- address1: 172 Lovely Street
7350
+ address1: 199 Lovely Street
7292
7351
  address2: Northwest
7293
7352
  postal_code: '10118'
7294
7353
  city: New York
@@ -7306,10 +7365,11 @@ paths:
7306
7365
  state_name: New York
7307
7366
  default_billing_address:
7308
7367
  id: addr_gbHJdmfrXB
7368
+ label:
7309
7369
  first_name: John
7310
7370
  last_name: Doe
7311
7371
  full_name: John Doe
7312
- address1: 172 Lovely Street
7372
+ address1: 199 Lovely Street
7313
7373
  address2: Northwest
7314
7374
  postal_code: '10118'
7315
7375
  city: New York
@@ -7327,10 +7387,11 @@ paths:
7327
7387
  state_name: New York
7328
7388
  default_shipping_address:
7329
7389
  id: addr_UkLWZg9DAJ
7390
+ label:
7330
7391
  first_name: John
7331
7392
  last_name: Doe
7332
7393
  full_name: John Doe
7333
- address1: 171 Lovely Street
7394
+ address1: 198 Lovely Street
7334
7395
  address2: Northwest
7335
7396
  postal_code: '10118'
7336
7397
  city: New York
@@ -7417,10 +7478,11 @@ paths:
7417
7478
  display_available_store_credit_total: "$0.00"
7418
7479
  addresses:
7419
7480
  - id: addr_UkLWZg9DAJ
7481
+ label:
7420
7482
  first_name: John
7421
7483
  last_name: Doe
7422
7484
  full_name: John Doe
7423
- address1: 173 Lovely Street
7485
+ address1: 200 Lovely Street
7424
7486
  address2: Northwest
7425
7487
  postal_code: '10118'
7426
7488
  city: New York
@@ -7437,10 +7499,11 @@ paths:
7437
7499
  country_iso: US
7438
7500
  state_name: New York
7439
7501
  - id: addr_gbHJdmfrXB
7502
+ label:
7440
7503
  first_name: John
7441
7504
  last_name: Doe
7442
7505
  full_name: John Doe
7443
- address1: 174 Lovely Street
7506
+ address1: 201 Lovely Street
7444
7507
  address2: Northwest
7445
7508
  postal_code: '10118'
7446
7509
  city: New York
@@ -7458,10 +7521,11 @@ paths:
7458
7521
  state_name: New York
7459
7522
  default_billing_address:
7460
7523
  id: addr_gbHJdmfrXB
7524
+ label:
7461
7525
  first_name: John
7462
7526
  last_name: Doe
7463
7527
  full_name: John Doe
7464
- address1: 174 Lovely Street
7528
+ address1: 201 Lovely Street
7465
7529
  address2: Northwest
7466
7530
  postal_code: '10118'
7467
7531
  city: New York
@@ -7479,10 +7543,11 @@ paths:
7479
7543
  state_name: New York
7480
7544
  default_shipping_address:
7481
7545
  id: addr_UkLWZg9DAJ
7546
+ label:
7482
7547
  first_name: John
7483
7548
  last_name: Doe
7484
7549
  full_name: John Doe
7485
- address1: 173 Lovely Street
7550
+ address1: 200 Lovely Street
7486
7551
  address2: Northwest
7487
7552
  postal_code: '10118'
7488
7553
  city: New York
@@ -9278,7 +9343,7 @@ paths:
9278
9343
  variant:
9279
9344
  id: variant_gbHJdmfrXB
9280
9345
  product_id: prod_gbHJdmfrXB
9281
- sku: SKU-306
9346
+ sku: SKU-307
9282
9347
  options_text: ''
9283
9348
  track_inventory: true
9284
9349
  media_count: 0
@@ -9927,15 +9992,18 @@ paths:
9927
9992
  message: Valid API key required
9928
9993
  schema:
9929
9994
  "$ref": "#/components/schemas/ErrorResponse"
9930
- "/api/v3/store/delivery_methods":
9995
+ "/api/v3/store/account/companies":
9931
9996
  get:
9932
- summary: List delivery methods
9997
+ summary: List my company memberships
9933
9998
  tags:
9934
- - Delivery
9999
+ - Companies
9935
10000
  security:
9936
10001
  - api_key: []
9937
- description: Storefront-visible delivery methods. Filter by fulfillment_type
9938
- to discover pickup options.
10002
+ bearer_auth: []
10003
+ description: |
10004
+ Returns the authenticated customer's company memberships, each with the node it
10005
+ is held on and the path of nodes above it. Standing covers the node and every
10006
+ node below it, so a membership on a parent authorizes buying for its divisions.
9939
10007
  x-codeSamples:
9940
10008
  - lang: javascript
9941
10009
  label: Spree SDK
@@ -9947,56 +10015,63 @@ paths:
9947
10015
  publishableKey: '<api-key>',
9948
10016
  })
9949
10017
 
9950
- const { data: pickupMethods } = await client.deliveryMethods.list({
9951
- fulfillment_type: 'pickup',
9952
- })
10018
+ // The buyer's memberships, each carrying its node and the path above it.
10019
+ const { data: memberships } = await client.account.companies({ token: '<token>' })
9953
10020
  parameters:
9954
10021
  - name: x-spree-api-key
9955
10022
  in: header
9956
10023
  required: true
9957
10024
  schema:
9958
10025
  type: string
9959
- - name: fulfillment_type
9960
- in: query
9961
- required: false
9962
- description: 'Filter: shipping, digital, pickup'
10026
+ - name: Authorization
10027
+ in: header
10028
+ required: true
9963
10029
  schema:
9964
10030
  type: string
9965
10031
  responses:
9966
10032
  '200':
9967
- description: delivery methods found
10033
+ description: memberships listed
9968
10034
  content:
9969
10035
  application/json:
9970
10036
  example:
9971
10037
  data:
9972
- - id: dm_gbHJdmfrXB
9973
- name: Store pickup
9974
- code: PICKUP
9975
- estimated_transit_business_days_min:
9976
- estimated_transit_business_days_max:
9977
- digital: false
9978
- pickup: true
9979
- pickup_point: false
9980
- meta:
9981
- page: 1
9982
- limit: 25
9983
- count: 1
9984
- pages: 1
9985
- from: 1
9986
- to: 1
9987
- in: 1
9988
- previous:
9989
- next:
9990
- "/api/v3/store/delivery_methods/{id}/pickup_locations":
10038
+ - id: cmem_UkLWZg9DAJ
10039
+ company_id: comp_UkLWZg9DAJ
10040
+ customer_id: cust_UkLWZg9DAJ
10041
+ email: pasty.koepp@farrell.name
10042
+ company:
10043
+ id: comp_UkLWZg9DAJ
10044
+ name: Acme Industrial
10045
+ kind: company
10046
+ parent_id:
10047
+ ancestors: []
10048
+ '401':
10049
+ description: not authenticated
10050
+ content:
10051
+ application/json:
10052
+ example:
10053
+ error:
10054
+ code: authentication_required
10055
+ message: Authentication required
10056
+ "/api/v3/store/companies/{id}":
10057
+ parameters:
10058
+ - name: id
10059
+ in: path
10060
+ required: true
10061
+ description: Company node ID (comp_...)
10062
+ schema:
10063
+ type: string
9991
10064
  get:
9992
- summary: List pickup locations
10065
+ summary: Get a company node
9993
10066
  tags:
9994
- - Delivery
10067
+ - Companies
9995
10068
  security:
9996
10069
  - api_key: []
9997
- description: Pickup-enabled stock locations for a pickup delivery method. Pass
9998
- cart_id to keep only locations that can fulfill the whole cart from local
9999
- stock.
10070
+ bearer_auth: []
10071
+ description: |
10072
+ Returns one node of the buyer's organization. Requires standing — a membership on
10073
+ the node or on one of its ancestors; any other node is not found rather than
10074
+ refused, so its existence is not disclosed.
10000
10075
  x-codeSamples:
10001
10076
  - lang: javascript
10002
10077
  label: Spree SDK
@@ -10008,104 +10083,116 @@ paths:
10008
10083
  publishableKey: '<api-key>',
10009
10084
  })
10010
10085
 
10011
- const { data: pickupLocations } = await client.deliveryMethods.pickupLocations('dm_abc123', {
10012
- cart_id: 'cart_abc123',
10013
- })
10086
+ const company = await client.companies.get('comp_86Rf07xd4z', { token: '<token>' })
10014
10087
  parameters:
10015
10088
  - name: x-spree-api-key
10016
10089
  in: header
10017
10090
  required: true
10018
10091
  schema:
10019
10092
  type: string
10020
- - name: id
10021
- in: path
10093
+ - name: Authorization
10094
+ in: header
10022
10095
  required: true
10023
- description: Delivery method prefixed ID
10024
- schema:
10025
- type: string
10026
- - name: cart_id
10027
- in: query
10028
- required: false
10029
- description: Cart prefixed ID for availability filtering
10030
10096
  schema:
10031
10097
  type: string
10032
10098
  responses:
10033
10099
  '200':
10034
- description: pickup locations found
10100
+ description: company found
10035
10101
  content:
10036
10102
  application/json:
10037
10103
  example:
10038
- data:
10039
- - id: sloc_UkLWZg9DAJ
10040
- name: Downtown
10041
- address1: 1600 Pennsylvania Ave NW
10042
- city: Washington
10043
- zipcode: '20500'
10044
- country_code: US
10045
- country_name: United States
10046
- state_code: AL
10047
- state_text: AL
10048
- pickup_ready_in_minutes:
10049
- pickup_instructions:
10050
- "/api/v3/store/sellers":
10051
- get:
10052
- summary: List sellers
10104
+ id: comp_UkLWZg9DAJ
10105
+ name: Acme Industrial
10106
+ kind: company
10107
+ parent_id:
10108
+ ancestors: []
10109
+ '404':
10110
+ description: no standing over this node
10111
+ content:
10112
+ application/json:
10113
+ example:
10114
+ error:
10115
+ code: record_not_found
10116
+ message: Company not found
10117
+ patch:
10118
+ summary: Update a company node
10053
10119
  tags:
10054
- - Sellers
10120
+ - Companies
10055
10121
  security:
10056
10122
  - api_key: []
10057
- description: |
10058
- Returns the sellers on this marketplace that a shopper can currently
10059
- buy from. A seller still onboarding, suspended, or away on holiday is
10060
- not listed — showing them would advertise a seller whose products
10061
- cannot be bought.
10062
-
10063
- The payload is the seller's public profile only. Nothing about how the
10064
- marketplace runs them — status, payout schedule, tax handling, contact
10065
- addresses — is exposed here.
10123
+ bearer_auth: []
10124
+ description: Renames the node. Structure the parent and the kind — is managed
10125
+ by the merchant, not by buyers.
10066
10126
  parameters:
10067
10127
  - name: x-spree-api-key
10068
10128
  in: header
10069
10129
  required: true
10070
10130
  schema:
10071
10131
  type: string
10072
- - name: page
10073
- in: query
10074
- required: false
10075
- schema:
10076
- type: integer
10077
- - name: limit
10078
- in: query
10079
- required: false
10132
+ - name: Authorization
10133
+ in: header
10134
+ required: true
10080
10135
  schema:
10081
- type: integer
10082
- - name: q[name_cont]
10083
- in: query
10084
- required: false
10085
- description: Filter by name
10136
+ type: string
10137
+ responses:
10138
+ '200':
10139
+ description: company updated
10140
+ content:
10141
+ application/json:
10142
+ example:
10143
+ id: comp_UkLWZg9DAJ
10144
+ name: Acme Industrial Group
10145
+ kind: company
10146
+ parent_id:
10147
+ ancestors: []
10148
+ requestBody:
10149
+ content:
10150
+ application/json:
10151
+ schema:
10152
+ type: object
10153
+ properties:
10154
+ name:
10155
+ type: string
10156
+ example: Acme Industrial Group
10157
+ "/api/v3/store/companies/{company_id}/members":
10158
+ parameters:
10159
+ - name: company_id
10160
+ in: path
10161
+ required: true
10162
+ description: Company node ID (comp_...)
10163
+ schema:
10164
+ type: string
10165
+ get:
10166
+ summary: List company members
10167
+ tags:
10168
+ - Companies
10169
+ security:
10170
+ - api_key: []
10171
+ bearer_auth: []
10172
+ description: The people with standing over this node. Within a company every
10173
+ member may read and manage the directory.
10174
+ parameters:
10175
+ - name: x-spree-api-key
10176
+ in: header
10177
+ required: true
10086
10178
  schema:
10087
10179
  type: string
10088
- - name: fields
10089
- in: query
10090
- required: false
10091
- description: Comma-separated list of fields to include. id is always included.
10180
+ - name: Authorization
10181
+ in: header
10182
+ required: true
10092
10183
  schema:
10093
10184
  type: string
10094
10185
  responses:
10095
10186
  '200':
10096
- description: sellers found
10187
+ description: members listed
10097
10188
  content:
10098
10189
  application/json:
10099
10190
  example:
10100
10191
  data:
10101
- - id: sel_UkLWZg9DAJ
10102
- name: Sparks Audio
10103
- slug: sparks-audio
10104
- about: ''
10105
- about_html: ''
10106
- logo_url:
10107
- square_logo_url:
10108
- cover_photo_url:
10192
+ - id: cmem_UkLWZg9DAJ
10193
+ company_id: comp_UkLWZg9DAJ
10194
+ customer_id: cust_UkLWZg9DAJ
10195
+ email: su_kuvalis@ward.biz
10109
10196
  meta:
10110
10197
  page: 1
10111
10198
  limit: 25
@@ -10116,75 +10203,895 @@ paths:
10116
10203
  in: 1
10117
10204
  previous:
10118
10205
  next:
10119
- schema:
10120
- type: object
10121
- properties:
10122
- data:
10123
- type: array
10124
- items:
10125
- "$ref": "#/components/schemas/Seller"
10126
- meta:
10127
- "$ref": "#/components/schemas/PaginationMeta"
10128
- '401':
10129
- description: unauthorized
10130
- content:
10131
- application/json:
10132
- example:
10133
- error:
10134
- code: invalid_token
10135
- message: Valid API key required
10136
- schema:
10137
- "$ref": "#/components/schemas/ErrorResponse"
10138
- "/api/v3/store/sellers/{id}":
10139
- get:
10140
- summary: Get a seller
10206
+ post:
10207
+ summary: Add a member by email
10141
10208
  tags:
10142
- - Sellers
10209
+ - Companies
10143
10210
  security:
10144
10211
  - api_key: []
10212
+ bearer_auth: []
10145
10213
  description: |
10146
- Returns a single seller's public profile, by slug or prefixed ID, so a
10147
- storefront can route `/sellers/sparks-audio` without holding an id.
10214
+ Adds a person to the node by email. An email that already belongs to a customer of
10215
+ this store becomes a membership immediately (a `cmem_...` id); any other email
10216
+ becomes an invitation (a `cinv_...` id) and the invite email goes out.
10217
+ x-codeSamples:
10218
+ - lang: javascript
10219
+ label: Spree SDK
10220
+ source: |-
10221
+ import { createClient } from '@spree/sdk'
10148
10222
 
10149
- A seller who cannot currently sell returns 404 rather than a profile.
10223
+ const client = createClient({
10224
+ baseUrl: 'https://your-store.com',
10225
+ publishableKey: '<api-key>',
10226
+ })
10227
+
10228
+ // An existing customer joins immediately (cmem_…); anyone else is emailed an
10229
+ // invitation (cinv_…).
10230
+ const member = await client.companies.members.create(
10231
+ 'comp_86Rf07xd4z',
10232
+ { customer_email: 'colleague@acme.test' },
10233
+ { token: '<token>' },
10234
+ )
10150
10235
  parameters:
10151
10236
  - name: x-spree-api-key
10152
10237
  in: header
10153
10238
  required: true
10154
10239
  schema:
10155
10240
  type: string
10156
- - name: id
10157
- in: path
10241
+ - name: Authorization
10242
+ in: header
10158
10243
  required: true
10159
- description: Seller slug (e.g., sparks-audio) or prefixed ID (e.g., sel_abc123)
10160
- schema:
10161
- type: string
10162
- - name: fields
10163
- in: query
10164
- required: false
10165
- description: Comma-separated list of fields to include. id is always included.
10166
10244
  schema:
10167
10245
  type: string
10168
10246
  responses:
10169
- '200':
10170
- description: seller found by slug
10247
+ '201':
10248
+ description: member added or invitation sent
10171
10249
  content:
10172
10250
  application/json:
10173
10251
  example:
10174
- id: sel_UkLWZg9DAJ
10175
- name: Sparks Audio
10176
- slug: sparks-audio
10177
- about: ''
10178
- about_html: ''
10179
- logo_url:
10180
- square_logo_url:
10181
- cover_photo_url:
10182
- schema:
10183
- "$ref": "#/components/schemas/Seller"
10184
- '404':
10185
- description: seller not found
10186
- content:
10187
- application/json:
10252
+ id: cmem_gbHJdmfrXB
10253
+ company_id: comp_UkLWZg9DAJ
10254
+ customer_id: cust_gbHJdmfrXB
10255
+ email: colleague@acme.test
10256
+ requestBody:
10257
+ content:
10258
+ application/json:
10259
+ schema:
10260
+ type: object
10261
+ properties:
10262
+ customer_email:
10263
+ type: string
10264
+ example: colleague@acme.test
10265
+ required:
10266
+ - customer_email
10267
+ "/api/v3/store/companies/{company_id}/addresses":
10268
+ parameters:
10269
+ - name: company_id
10270
+ in: path
10271
+ required: true
10272
+ description: Company node ID (comp_...)
10273
+ schema:
10274
+ type: string
10275
+ get:
10276
+ summary: List the company address book
10277
+ tags:
10278
+ - Companies
10279
+ security:
10280
+ - api_key: []
10281
+ bearer_auth: []
10282
+ description: The labeled ship-to and bill-to sites this node owns. A node with
10283
+ no default of its own falls back to its nearest ancestor when prefilling checkout.
10284
+ parameters:
10285
+ - name: x-spree-api-key
10286
+ in: header
10287
+ required: true
10288
+ schema:
10289
+ type: string
10290
+ - name: Authorization
10291
+ in: header
10292
+ required: true
10293
+ schema:
10294
+ type: string
10295
+ responses:
10296
+ '200':
10297
+ description: addresses listed
10298
+ content:
10299
+ application/json:
10300
+ example:
10301
+ data:
10302
+ - id: addr_EfhxLZ9ck8
10303
+ label: Headquarters
10304
+ first_name:
10305
+ last_name:
10306
+ full_name: ''
10307
+ address1: 159 Lovely Street
10308
+ address2: Northwest
10309
+ postal_code: '10118'
10310
+ city: New York
10311
+ phone: 555-555-0199
10312
+ company: Company
10313
+ country_name: United States
10314
+ country_code: US
10315
+ state_text: NY
10316
+ state_code: NY
10317
+ quick_checkout: false
10318
+ is_default_billing: false
10319
+ is_default_shipping: false
10320
+ state_abbr: NY
10321
+ country_iso: US
10322
+ state_name: New York
10323
+ meta:
10324
+ page: 1
10325
+ limit: 25
10326
+ count: 1
10327
+ pages: 1
10328
+ from: 1
10329
+ to: 1
10330
+ in: 1
10331
+ previous:
10332
+ next:
10333
+ "/api/v3/store/companies/{company_id}/addresses/{id}":
10334
+ parameters:
10335
+ - name: company_id
10336
+ in: path
10337
+ required: true
10338
+ description: Company node ID (comp_...)
10339
+ schema:
10340
+ type: string
10341
+ - name: id
10342
+ in: path
10343
+ required: true
10344
+ description: Address ID (addr_...)
10345
+ schema:
10346
+ type: string
10347
+ patch:
10348
+ summary: Update an address book entry
10349
+ tags:
10350
+ - Companies
10351
+ security:
10352
+ - api_key: []
10353
+ bearer_auth: []
10354
+ description: Renames a site or moves the default ship-to or bill-to flag to
10355
+ it. Only one entry per node holds each default.
10356
+ parameters:
10357
+ - name: x-spree-api-key
10358
+ in: header
10359
+ required: true
10360
+ schema:
10361
+ type: string
10362
+ - name: Authorization
10363
+ in: header
10364
+ required: true
10365
+ schema:
10366
+ type: string
10367
+ responses:
10368
+ '200':
10369
+ description: address book entry updated
10370
+ content:
10371
+ application/json:
10372
+ example:
10373
+ id: addr_EfhxLZ9ck8
10374
+ label: Northern Warehouse
10375
+ first_name:
10376
+ last_name:
10377
+ full_name: ''
10378
+ address1: 162 Lovely Street
10379
+ address2: Northwest
10380
+ postal_code: '10118'
10381
+ city: New York
10382
+ phone: 555-555-0199
10383
+ company: Company
10384
+ country_name: United States
10385
+ country_code: US
10386
+ state_text: NY
10387
+ state_code: NY
10388
+ quick_checkout: false
10389
+ is_default_billing: false
10390
+ is_default_shipping: true
10391
+ state_abbr: NY
10392
+ country_iso: US
10393
+ state_name: New York
10394
+ requestBody:
10395
+ content:
10396
+ application/json:
10397
+ schema:
10398
+ type: object
10399
+ properties:
10400
+ label:
10401
+ type: string
10402
+ example: Northern Warehouse
10403
+ default_shipping:
10404
+ type: boolean
10405
+ example: true
10406
+ delete:
10407
+ summary: Remove an address book entry
10408
+ tags:
10409
+ - Companies
10410
+ security:
10411
+ - api_key: []
10412
+ bearer_auth: []
10413
+ description: Takes the site out of the address book. Orders already placed to
10414
+ it keep their own copy of the address.
10415
+ parameters:
10416
+ - name: x-spree-api-key
10417
+ in: header
10418
+ required: true
10419
+ schema:
10420
+ type: string
10421
+ - name: Authorization
10422
+ in: header
10423
+ required: true
10424
+ schema:
10425
+ type: string
10426
+ responses:
10427
+ '204':
10428
+ description: address book entry removed
10429
+ "/api/v3/store/companies/{company_id}/invitations/{id}":
10430
+ parameters:
10431
+ - name: company_id
10432
+ in: path
10433
+ required: true
10434
+ description: Company node ID (comp_...)
10435
+ schema:
10436
+ type: string
10437
+ - name: id
10438
+ in: path
10439
+ required: true
10440
+ description: Invitation ID (cinv_...)
10441
+ schema:
10442
+ type: string
10443
+ delete:
10444
+ summary: Revoke an invitation
10445
+ tags:
10446
+ - Companies
10447
+ security:
10448
+ - api_key: []
10449
+ bearer_auth: []
10450
+ description: Withdraws a pending invitation, spending its token. Any member
10451
+ with standing over the node may revoke.
10452
+ parameters:
10453
+ - name: x-spree-api-key
10454
+ in: header
10455
+ required: true
10456
+ schema:
10457
+ type: string
10458
+ - name: Authorization
10459
+ in: header
10460
+ required: true
10461
+ schema:
10462
+ type: string
10463
+ responses:
10464
+ '204':
10465
+ description: invitation revoked
10466
+ "/api/v3/store/companies/{company_id}/orders":
10467
+ parameters:
10468
+ - name: company_id
10469
+ in: path
10470
+ required: true
10471
+ description: Company node ID (comp_...)
10472
+ schema:
10473
+ type: string
10474
+ get:
10475
+ summary: List the company purchases
10476
+ tags:
10477
+ - Companies
10478
+ security:
10479
+ - api_key: []
10480
+ bearer_auth: []
10481
+ description: Completed orders placed for this node and every node below it,
10482
+ so a parent sees what its divisions bought.
10483
+ parameters:
10484
+ - name: x-spree-api-key
10485
+ in: header
10486
+ required: true
10487
+ schema:
10488
+ type: string
10489
+ - name: Authorization
10490
+ in: header
10491
+ required: true
10492
+ schema:
10493
+ type: string
10494
+ responses:
10495
+ '200':
10496
+ description: orders listed
10497
+ content:
10498
+ application/json:
10499
+ example:
10500
+ data:
10501
+ - id: or_UkLWZg9DAJ
10502
+ market_id: mkt_UkLWZg9DAJ
10503
+ cart_id:
10504
+ channel_id: ch_UkLWZg9DAJ
10505
+ company_id: comp_UkLWZg9DAJ
10506
+ company_name: Acme Industrial
10507
+ number: R1001
10508
+ email: chanell_langosh@schamberger.info
10509
+ customer_note:
10510
+ currency: USD
10511
+ locale: en
10512
+ total_quantity: 1
10513
+ coupon_code:
10514
+ fulfillment_status:
10515
+ payment_status:
10516
+ completed_at: '2026-01-15T12:00:00.000Z'
10517
+ item_total: '10.0'
10518
+ display_item_total: "$10.00"
10519
+ adjustment_total: '0.0'
10520
+ display_adjustment_total: "$0.00"
10521
+ discount_total: '0.0'
10522
+ display_discount_total: "$0.00"
10523
+ tax_total: '0.0'
10524
+ display_tax_total: "$0.00"
10525
+ included_tax_total: '0.0'
10526
+ display_included_tax_total: "$0.00"
10527
+ additional_tax_total: '0.0'
10528
+ display_additional_tax_total: "$0.00"
10529
+ total: '110.0'
10530
+ display_total: "$110.00"
10531
+ gift_card_total: '0.0'
10532
+ display_gift_card_total: "$0.00"
10533
+ amount_due: '110.0'
10534
+ display_amount_due: "$110.00"
10535
+ delivery_total: '100.0'
10536
+ display_delivery_total: "$100.00"
10537
+ fee_total: '0.0'
10538
+ display_fee_total: "$0.00"
10539
+ store_credit_total: '0.0'
10540
+ display_store_credit_total: "$0.00"
10541
+ covered_by_store_credit: false
10542
+ discounts: []
10543
+ fees: []
10544
+ items:
10545
+ - id: li_UkLWZg9DAJ
10546
+ variant_id: variant_UkLWZg9DAJ
10547
+ seller_id:
10548
+ preorder: false
10549
+ preorder_ships_at:
10550
+ quantity: 1
10551
+ currency: USD
10552
+ name: Product 1585649
10553
+ slug: product-1585649
10554
+ options_text: ''
10555
+ price: '10.0'
10556
+ display_price: "$10.00"
10557
+ total: '10.0'
10558
+ display_total: "$10.00"
10559
+ adjustment_total: '0.0'
10560
+ display_adjustment_total: "$0.00"
10561
+ additional_tax_total: '0.0'
10562
+ display_additional_tax_total: "$0.00"
10563
+ included_tax_total: '0.0'
10564
+ display_included_tax_total: "$0.00"
10565
+ discount_total: '0.0'
10566
+ display_discount_total: "$0.00"
10567
+ pre_tax_amount: '10.0'
10568
+ display_pre_tax_amount: "$10.00"
10569
+ discounted_amount: '10.0'
10570
+ display_discounted_amount: "$10.00"
10571
+ display_compare_at_amount: "$0.00"
10572
+ compare_at_amount:
10573
+ thumbnail_url:
10574
+ option_values: []
10575
+ digital_links: []
10576
+ fulfillments:
10577
+ - id: ful_UkLWZg9DAJ
10578
+ number: R1001-F1
10579
+ tracking: U10000
10580
+ tracking_url:
10581
+ tracking_carrier:
10582
+ tracking_carrier_name:
10583
+ pickup_point_data:
10584
+ selected_delivery_rate_id: dr_gbHJdmfrXB
10585
+ cost: '100.0'
10586
+ display_cost: "$100.00"
10587
+ total: '100.0'
10588
+ display_total: "$100.00"
10589
+ discount_total: '0.0'
10590
+ display_discount_total: "$0.00"
10591
+ additional_tax_total: '0.0'
10592
+ display_additional_tax_total: "$0.00"
10593
+ included_tax_total: '0.0'
10594
+ display_included_tax_total: "$0.00"
10595
+ tax_total: '0.0'
10596
+ display_tax_total: "$0.00"
10597
+ status: unfulfilled
10598
+ fulfillment_type: shipping
10599
+ fulfilled_at:
10600
+ tracking_status:
10601
+ estimated_delivery_at:
10602
+ delivered_at:
10603
+ items:
10604
+ - item_id: li_UkLWZg9DAJ
10605
+ variant_id: variant_UkLWZg9DAJ
10606
+ quantity: 1
10607
+ delivery_method:
10608
+ id: dm_UkLWZg9DAJ
10609
+ name: UPS Ground
10610
+ code: UPS_GROUND
10611
+ estimated_transit_business_days_min:
10612
+ estimated_transit_business_days_max:
10613
+ digital: false
10614
+ pickup: false
10615
+ pickup_point: false
10616
+ stock_location:
10617
+ id: sloc_UkLWZg9DAJ
10618
+ name: Kali Pacocha
10619
+ address1: 1600 Pennsylvania Ave NW
10620
+ city: Washington
10621
+ zipcode: '20500'
10622
+ country_code: US
10623
+ country_name: United States
10624
+ state_code: AL
10625
+ state_text: AL
10626
+ pickup_ready_in_minutes:
10627
+ pickup_instructions:
10628
+ delivery_rates:
10629
+ - id: dr_gbHJdmfrXB
10630
+ delivery_method_id: dm_UkLWZg9DAJ
10631
+ name: UPS Ground
10632
+ selected: true
10633
+ cost: '10.0'
10634
+ total: '10.0'
10635
+ additional_tax_total: '0.0'
10636
+ included_tax_total: '0.0'
10637
+ tax_total: '0.0'
10638
+ carrier:
10639
+ service_level:
10640
+ estimated_delivery_date:
10641
+ display_cost: "$10.00"
10642
+ display_total: "$10.00"
10643
+ display_additional_tax_total: "$0.00"
10644
+ display_included_tax_total: "$0.00"
10645
+ display_tax_total: "$0.00"
10646
+ delivery_method:
10647
+ id: dm_UkLWZg9DAJ
10648
+ name: UPS Ground
10649
+ code: UPS_GROUND
10650
+ estimated_transit_business_days_min:
10651
+ estimated_transit_business_days_max:
10652
+ digital: false
10653
+ pickup: false
10654
+ pickup_point: false
10655
+ payments: []
10656
+ billing_address:
10657
+ id: addr_EfhxLZ9ck8
10658
+ label:
10659
+ first_name: John
10660
+ last_name: Doe
10661
+ full_name: John Doe
10662
+ address1: 170 Lovely Street
10663
+ address2: Northwest
10664
+ postal_code: '10118'
10665
+ city: New York
10666
+ phone: 555-555-0199
10667
+ company: Company
10668
+ country_name: United States
10669
+ country_code: US
10670
+ state_text: NY
10671
+ state_code: NY
10672
+ quick_checkout: false
10673
+ is_default_billing: false
10674
+ is_default_shipping: false
10675
+ state_abbr: NY
10676
+ country_iso: US
10677
+ state_name: New York
10678
+ shipping_address:
10679
+ id: addr_VqXmZF31wY
10680
+ label:
10681
+ first_name: John
10682
+ last_name: Doe
10683
+ full_name: John Doe
10684
+ address1: 171 Lovely Street
10685
+ address2: Northwest
10686
+ postal_code: '10118'
10687
+ city: New York
10688
+ phone: 555-555-0199
10689
+ company: Company
10690
+ country_name: United States
10691
+ country_code: US
10692
+ state_text: NY
10693
+ state_code: NY
10694
+ quick_checkout: false
10695
+ is_default_billing: false
10696
+ is_default_shipping: false
10697
+ state_abbr: NY
10698
+ country_iso: US
10699
+ state_name: New York
10700
+ gift_card:
10701
+ market:
10702
+ id: mkt_UkLWZg9DAJ
10703
+ name: United States
10704
+ currency: USD
10705
+ default_locale: en
10706
+ tax_inclusive: false
10707
+ default: true
10708
+ country_codes:
10709
+ - US
10710
+ supported_locales:
10711
+ - en
10712
+ meta:
10713
+ page: 1
10714
+ limit: 25
10715
+ count: 1
10716
+ pages: 1
10717
+ from: 1
10718
+ to: 1
10719
+ in: 1
10720
+ previous:
10721
+ next:
10722
+ "/api/v3/store/company_invitations/{token}":
10723
+ parameters:
10724
+ - name: token
10725
+ in: path
10726
+ required: true
10727
+ description: Plaintext invitation token from the invite email
10728
+ schema:
10729
+ type: string
10730
+ get:
10731
+ summary: Look up an invitation
10732
+ tags:
10733
+ - Companies
10734
+ security:
10735
+ - api_key: []
10736
+ description: |
10737
+ Shows what is being joined, so the acceptance page can render before the invitee
10738
+ has an account. Deliberately unauthenticated — the token from the email is the
10739
+ credential. Spent, revoked and expired tokens are not found.
10740
+ parameters:
10741
+ - name: x-spree-api-key
10742
+ in: header
10743
+ required: true
10744
+ schema:
10745
+ type: string
10746
+ responses:
10747
+ '200':
10748
+ description: invitation found
10749
+ content:
10750
+ application/json:
10751
+ example:
10752
+ id: cinv_UkLWZg9DAJ
10753
+ email: new@acme.test
10754
+ expires_at: '2026-02-14T12:00:00.000Z'
10755
+ company_id: comp_UkLWZg9DAJ
10756
+ status: pending
10757
+ company_name: Acme Industrial
10758
+ store_name: Spree Test Store
10759
+ '404':
10760
+ description: token spent, revoked or expired
10761
+ content:
10762
+ application/json:
10763
+ example:
10764
+ error:
10765
+ code: record_not_found
10766
+ message: Company invitation not found
10767
+ "/api/v3/store/company_invitations/{token}/accept":
10768
+ parameters:
10769
+ - name: token
10770
+ in: path
10771
+ required: true
10772
+ description: Plaintext invitation token from the invite email
10773
+ schema:
10774
+ type: string
10775
+ post:
10776
+ summary: Accept an invitation
10777
+ tags:
10778
+ - Companies
10779
+ security:
10780
+ - api_key: []
10781
+ description: |
10782
+ Turns the invitation into a membership. Send a registration payload to create the
10783
+ account — it is always created with the invited email — or call it authenticated as
10784
+ the customer who owns that email to bind the invitation to the existing account.
10785
+ x-codeSamples:
10786
+ - lang: javascript
10787
+ label: Spree SDK
10788
+ source: |-
10789
+ import { createClient } from '@spree/sdk'
10790
+
10791
+ const client = createClient({
10792
+ baseUrl: 'https://your-store.com',
10793
+ publishableKey: '<api-key>',
10794
+ })
10795
+
10796
+ // Unauthenticated: the token from the invite email is the credential, and the
10797
+ // registration payload creates the account with the invited address.
10798
+ const membership = await client.companyInvitations.accept('<invitation-token>', {
10799
+ first_name: 'Ada',
10800
+ password: 'a-strong-password',
10801
+ password_confirmation: 'a-strong-password',
10802
+ })
10803
+ parameters:
10804
+ - name: x-spree-api-key
10805
+ in: header
10806
+ required: true
10807
+ schema:
10808
+ type: string
10809
+ responses:
10810
+ '201':
10811
+ description: membership created
10812
+ content:
10813
+ application/json:
10814
+ example:
10815
+ id: cmem_UkLWZg9DAJ
10816
+ company_id: comp_UkLWZg9DAJ
10817
+ customer_id: cust_UkLWZg9DAJ
10818
+ email: new@acme.test
10819
+ requestBody:
10820
+ content:
10821
+ application/json:
10822
+ schema:
10823
+ type: object
10824
+ properties:
10825
+ first_name:
10826
+ type: string
10827
+ example: Ada
10828
+ last_name:
10829
+ type: string
10830
+ example: Lovelace
10831
+ password:
10832
+ type: string
10833
+ example: a-strong-password
10834
+ password_confirmation:
10835
+ type: string
10836
+ example: a-strong-password
10837
+ "/api/v3/store/delivery_methods":
10838
+ get:
10839
+ summary: List delivery methods
10840
+ tags:
10841
+ - Delivery
10842
+ security:
10843
+ - api_key: []
10844
+ description: Storefront-visible delivery methods. Filter by fulfillment_type
10845
+ to discover pickup options.
10846
+ x-codeSamples:
10847
+ - lang: javascript
10848
+ label: Spree SDK
10849
+ source: |-
10850
+ import { createClient } from '@spree/sdk'
10851
+
10852
+ const client = createClient({
10853
+ baseUrl: 'https://your-store.com',
10854
+ publishableKey: '<api-key>',
10855
+ })
10856
+
10857
+ const { data: pickupMethods } = await client.deliveryMethods.list({
10858
+ fulfillment_type: 'pickup',
10859
+ })
10860
+ parameters:
10861
+ - name: x-spree-api-key
10862
+ in: header
10863
+ required: true
10864
+ schema:
10865
+ type: string
10866
+ - name: fulfillment_type
10867
+ in: query
10868
+ required: false
10869
+ description: 'Filter: shipping, digital, pickup'
10870
+ schema:
10871
+ type: string
10872
+ responses:
10873
+ '200':
10874
+ description: delivery methods found
10875
+ content:
10876
+ application/json:
10877
+ example:
10878
+ data:
10879
+ - id: dm_gbHJdmfrXB
10880
+ name: Store pickup
10881
+ code: PICKUP
10882
+ estimated_transit_business_days_min:
10883
+ estimated_transit_business_days_max:
10884
+ digital: false
10885
+ pickup: true
10886
+ pickup_point: false
10887
+ meta:
10888
+ page: 1
10889
+ limit: 25
10890
+ count: 1
10891
+ pages: 1
10892
+ from: 1
10893
+ to: 1
10894
+ in: 1
10895
+ previous:
10896
+ next:
10897
+ "/api/v3/store/delivery_methods/{id}/pickup_locations":
10898
+ get:
10899
+ summary: List pickup locations
10900
+ tags:
10901
+ - Delivery
10902
+ security:
10903
+ - api_key: []
10904
+ description: Pickup-enabled stock locations for a pickup delivery method. Pass
10905
+ cart_id to keep only locations that can fulfill the whole cart from local
10906
+ stock.
10907
+ x-codeSamples:
10908
+ - lang: javascript
10909
+ label: Spree SDK
10910
+ source: |-
10911
+ import { createClient } from '@spree/sdk'
10912
+
10913
+ const client = createClient({
10914
+ baseUrl: 'https://your-store.com',
10915
+ publishableKey: '<api-key>',
10916
+ })
10917
+
10918
+ const { data: pickupLocations } = await client.deliveryMethods.pickupLocations('dm_abc123', {
10919
+ cart_id: 'cart_abc123',
10920
+ })
10921
+ parameters:
10922
+ - name: x-spree-api-key
10923
+ in: header
10924
+ required: true
10925
+ schema:
10926
+ type: string
10927
+ - name: id
10928
+ in: path
10929
+ required: true
10930
+ description: Delivery method prefixed ID
10931
+ schema:
10932
+ type: string
10933
+ - name: cart_id
10934
+ in: query
10935
+ required: false
10936
+ description: Cart prefixed ID for availability filtering
10937
+ schema:
10938
+ type: string
10939
+ responses:
10940
+ '200':
10941
+ description: pickup locations found
10942
+ content:
10943
+ application/json:
10944
+ example:
10945
+ data:
10946
+ - id: sloc_UkLWZg9DAJ
10947
+ name: Downtown
10948
+ address1: 1600 Pennsylvania Ave NW
10949
+ city: Washington
10950
+ zipcode: '20500'
10951
+ country_code: US
10952
+ country_name: United States
10953
+ state_code: AL
10954
+ state_text: AL
10955
+ pickup_ready_in_minutes:
10956
+ pickup_instructions:
10957
+ "/api/v3/store/sellers":
10958
+ get:
10959
+ summary: List sellers
10960
+ tags:
10961
+ - Sellers
10962
+ security:
10963
+ - api_key: []
10964
+ description: |
10965
+ Returns the sellers on this marketplace that a shopper can currently
10966
+ buy from. A seller still onboarding, suspended, or away on holiday is
10967
+ not listed — showing them would advertise a seller whose products
10968
+ cannot be bought.
10969
+
10970
+ The payload is the seller's public profile only. Nothing about how the
10971
+ marketplace runs them — status, payout schedule, tax handling, contact
10972
+ addresses — is exposed here.
10973
+ parameters:
10974
+ - name: x-spree-api-key
10975
+ in: header
10976
+ required: true
10977
+ schema:
10978
+ type: string
10979
+ - name: page
10980
+ in: query
10981
+ required: false
10982
+ schema:
10983
+ type: integer
10984
+ - name: limit
10985
+ in: query
10986
+ required: false
10987
+ schema:
10988
+ type: integer
10989
+ - name: q[name_cont]
10990
+ in: query
10991
+ required: false
10992
+ description: Filter by name
10993
+ schema:
10994
+ type: string
10995
+ - name: fields
10996
+ in: query
10997
+ required: false
10998
+ description: Comma-separated list of fields to include. id is always included.
10999
+ schema:
11000
+ type: string
11001
+ responses:
11002
+ '200':
11003
+ description: sellers found
11004
+ content:
11005
+ application/json:
11006
+ example:
11007
+ data:
11008
+ - id: sel_UkLWZg9DAJ
11009
+ name: Sparks Audio
11010
+ slug: sparks-audio
11011
+ about: ''
11012
+ about_html: ''
11013
+ logo_url:
11014
+ square_logo_url:
11015
+ cover_photo_url:
11016
+ meta:
11017
+ page: 1
11018
+ limit: 25
11019
+ count: 1
11020
+ pages: 1
11021
+ from: 1
11022
+ to: 1
11023
+ in: 1
11024
+ previous:
11025
+ next:
11026
+ schema:
11027
+ type: object
11028
+ properties:
11029
+ data:
11030
+ type: array
11031
+ items:
11032
+ "$ref": "#/components/schemas/Seller"
11033
+ meta:
11034
+ "$ref": "#/components/schemas/PaginationMeta"
11035
+ '401':
11036
+ description: unauthorized
11037
+ content:
11038
+ application/json:
11039
+ example:
11040
+ error:
11041
+ code: invalid_token
11042
+ message: Valid API key required
11043
+ schema:
11044
+ "$ref": "#/components/schemas/ErrorResponse"
11045
+ "/api/v3/store/sellers/{id}":
11046
+ get:
11047
+ summary: Get a seller
11048
+ tags:
11049
+ - Sellers
11050
+ security:
11051
+ - api_key: []
11052
+ description: |
11053
+ Returns a single seller's public profile, by slug or prefixed ID, so a
11054
+ storefront can route `/sellers/sparks-audio` without holding an id.
11055
+
11056
+ A seller who cannot currently sell returns 404 rather than a profile.
11057
+ parameters:
11058
+ - name: x-spree-api-key
11059
+ in: header
11060
+ required: true
11061
+ schema:
11062
+ type: string
11063
+ - name: id
11064
+ in: path
11065
+ required: true
11066
+ description: Seller slug (e.g., sparks-audio) or prefixed ID (e.g., sel_abc123)
11067
+ schema:
11068
+ type: string
11069
+ - name: fields
11070
+ in: query
11071
+ required: false
11072
+ description: Comma-separated list of fields to include. id is always included.
11073
+ schema:
11074
+ type: string
11075
+ responses:
11076
+ '200':
11077
+ description: seller found by slug
11078
+ content:
11079
+ application/json:
11080
+ example:
11081
+ id: sel_UkLWZg9DAJ
11082
+ name: Sparks Audio
11083
+ slug: sparks-audio
11084
+ about: ''
11085
+ about_html: ''
11086
+ logo_url:
11087
+ square_logo_url:
11088
+ cover_photo_url:
11089
+ schema:
11090
+ "$ref": "#/components/schemas/Seller"
11091
+ '404':
11092
+ description: seller not found
11093
+ content:
11094
+ application/json:
10188
11095
  example:
10189
11096
  error:
10190
11097
  code: record_not_found
@@ -10557,6 +11464,9 @@ components:
10557
11464
  properties:
10558
11465
  id:
10559
11466
  type: string
11467
+ label:
11468
+ type: string
11469
+ nullable: true
10560
11470
  first_name:
10561
11471
  type: string
10562
11472
  nullable: true
@@ -10609,6 +11519,7 @@ components:
10609
11519
  nullable: true
10610
11520
  required:
10611
11521
  - id
11522
+ - label
10612
11523
  - first_name
10613
11524
  - last_name
10614
11525
  - full_name
@@ -10681,6 +11592,12 @@ components:
10681
11592
  preferred_stock_location_id:
10682
11593
  type: string
10683
11594
  nullable: true
11595
+ company_id:
11596
+ type: string
11597
+ nullable: true
11598
+ company_name:
11599
+ type: string
11600
+ nullable: true
10684
11601
  number:
10685
11602
  type: string
10686
11603
  token:
@@ -10836,6 +11753,8 @@ components:
10836
11753
  - market_id
10837
11754
  - channel_id
10838
11755
  - preferred_stock_location_id
11756
+ - company_id
11757
+ - company_name
10839
11758
  - number
10840
11759
  - token
10841
11760
  - email
@@ -11149,6 +12068,66 @@ components:
11149
12068
  - image_url
11150
12069
  - square_image_url
11151
12070
  x-typelizer: true
12071
+ CompanyInvitation:
12072
+ type: object
12073
+ properties:
12074
+ id:
12075
+ type: string
12076
+ email:
12077
+ type: string
12078
+ expires_at:
12079
+ type: string
12080
+ nullable: true
12081
+ company_id:
12082
+ type: string
12083
+ status:
12084
+ type: string
12085
+ required:
12086
+ - id
12087
+ - email
12088
+ - expires_at
12089
+ - company_id
12090
+ - status
12091
+ x-typelizer: true
12092
+ CompanyMembership:
12093
+ type: object
12094
+ properties:
12095
+ id:
12096
+ type: string
12097
+ company_id:
12098
+ type: string
12099
+ customer_id:
12100
+ type: string
12101
+ email:
12102
+ type: string
12103
+ nullable: true
12104
+ required:
12105
+ - id
12106
+ - company_id
12107
+ - customer_id
12108
+ - email
12109
+ x-typelizer: true
12110
+ Company:
12111
+ type: object
12112
+ properties:
12113
+ id:
12114
+ type: string
12115
+ name:
12116
+ type: string
12117
+ kind:
12118
+ type: string
12119
+ parent_id:
12120
+ type: string
12121
+ nullable: true
12122
+ ancestors:
12123
+ type: object
12124
+ required:
12125
+ - id
12126
+ - name
12127
+ - kind
12128
+ - parent_id
12129
+ - ancestors
12130
+ x-typelizer: true
11152
12131
  Country:
11153
12132
  type: object
11154
12133
  properties:
@@ -12330,6 +13309,12 @@ components:
12330
13309
  channel_id:
12331
13310
  type: string
12332
13311
  nullable: true
13312
+ company_id:
13313
+ type: string
13314
+ nullable: true
13315
+ company_name:
13316
+ type: string
13317
+ nullable: true
12333
13318
  number:
12334
13319
  type: string
12335
13320
  email:
@@ -12471,6 +13456,8 @@ components:
12471
13456
  - market_id
12472
13457
  - cart_id
12473
13458
  - channel_id
13459
+ - company_id
13460
+ - company_name
12474
13461
  - number
12475
13462
  - email
12476
13463
  - customer_note