@spree/docs 0.1.179 → 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.
@@ -368,13 +368,10 @@ paths:
368
368
  publishableKey: '<api-key>',
369
369
  })
370
370
 
371
- const auth = await client.passwordResets.update(
372
- 'reset-token-from-email',
373
- {
374
- password: 'newsecurepassword',
375
- password_confirmation: 'newsecurepassword',
376
- }
377
- )
371
+ const auth = await client.passwordResets.update('reset-token-from-email', {
372
+ password: 'newsecurepassword',
373
+ password_confirmation: 'newsecurepassword',
374
+ })
378
375
  parameters:
379
376
  - name: x-spree-api-key
380
377
  in: header
@@ -879,8 +876,8 @@ paths:
879
876
  example:
880
877
  data:
881
878
  - id: prod_UkLWZg9DAJ
882
- name: Product 1496979
883
- slug: product-1496979
879
+ name: Product 1576979
880
+ slug: product-1576979
884
881
  meta_title:
885
882
  meta_description:
886
883
  meta_keywords:
@@ -1054,8 +1051,8 @@ paths:
1054
1051
  example:
1055
1052
  data:
1056
1053
  - id: prod_UkLWZg9DAJ
1057
- name: Product 1949085
1058
- slug: product-1949085
1054
+ name: Product 2039085
1055
+ slug: product-2039085
1059
1056
  meta_title:
1060
1057
  meta_description:
1061
1058
  meta_keywords:
@@ -1086,8 +1083,8 @@ paths:
1086
1083
  original_price:
1087
1084
  seller_id:
1088
1085
  - id: prod_gbHJdmfrXB
1089
- name: Product 1958209
1090
- slug: product-1958209
1086
+ name: Product 2048209
1087
+ slug: product-2048209
1091
1088
  meta_title:
1092
1089
  meta_description:
1093
1090
  meta_keywords:
@@ -1215,8 +1212,8 @@ paths:
1215
1212
  application/json:
1216
1213
  example:
1217
1214
  id: prod_UkLWZg9DAJ
1218
- name: Product 2226885
1219
- slug: product-2226885
1215
+ name: Product 2316885
1216
+ slug: product-2316885
1220
1217
  meta_title:
1221
1218
  meta_description:
1222
1219
  meta_keywords:
@@ -1501,6 +1498,8 @@ paths:
1501
1498
  market_id: mkt_UkLWZg9DAJ
1502
1499
  channel_id: ch_UkLWZg9DAJ
1503
1500
  preferred_stock_location_id:
1501
+ company_id:
1502
+ company_name:
1504
1503
  number: cart_UkLWZg9DAJ
1505
1504
  token: ckMf2iQ6r5adLceTPfKVH9BP
1506
1505
  email:
@@ -1565,8 +1564,8 @@ paths:
1565
1564
  preorder_ships_at:
1566
1565
  quantity: 1
1567
1566
  currency: USD
1568
- name: Product 123715
1569
- slug: product-123715
1567
+ name: Product 131715
1568
+ slug: product-131715
1570
1569
  options_text: ''
1571
1570
  price: '10.0'
1572
1571
  display_price: "$10.00"
@@ -1610,6 +1609,8 @@ paths:
1610
1609
  market_id: mkt_UkLWZg9DAJ
1611
1610
  channel_id: ch_UkLWZg9DAJ
1612
1611
  preferred_stock_location_id:
1612
+ company_id:
1613
+ company_name:
1613
1614
  number: cart_gbHJdmfrXB
1614
1615
  token: pvLw1ZWLLQNxh1uvSPUCdSmt
1615
1616
  email:
@@ -1674,8 +1675,8 @@ paths:
1674
1675
  preorder_ships_at:
1675
1676
  quantity: 1
1676
1677
  currency: USD
1677
- name: Product 1242171
1678
- slug: product-1242171
1678
+ name: Product 1322171
1679
+ slug: product-1322171
1679
1680
  options_text: ''
1680
1681
  price: '10.0'
1681
1682
  display_price: "$10.00"
@@ -1760,9 +1761,7 @@ paths:
1760
1761
 
1761
1762
  // Create a cart with items
1762
1763
  const cartWithItems = await client.carts.create({
1763
- items: [
1764
- { variant_id: 'variant_abc123', quantity: 2 },
1765
- ],
1764
+ items: [{ variant_id: 'variant_abc123', quantity: 2 }],
1766
1765
  })
1767
1766
  parameters:
1768
1767
  - name: x-spree-api-key
@@ -1792,6 +1791,8 @@ paths:
1792
1791
  market_id: mkt_UkLWZg9DAJ
1793
1792
  channel_id: ch_UkLWZg9DAJ
1794
1793
  preferred_stock_location_id:
1794
+ company_id:
1795
+ company_name:
1795
1796
  number: cart_UkLWZg9DAJ
1796
1797
  token: jBrNbC8FSNyavqebdqu7e3uL
1797
1798
  email:
@@ -1960,6 +1961,8 @@ paths:
1960
1961
  market_id: mkt_UkLWZg9DAJ
1961
1962
  channel_id: ch_UkLWZg9DAJ
1962
1963
  preferred_stock_location_id:
1964
+ company_id:
1965
+ company_name:
1963
1966
  number: cart_UkLWZg9DAJ
1964
1967
  token: HnnryvFFwjfx9P6ykByF4Gg2
1965
1968
  email:
@@ -1969,7 +1972,7 @@ paths:
1969
1972
  total_quantity: 0
1970
1973
  warnings:
1971
1974
  - code: line_item_removed
1972
- message: Product 128307 was removed because it was sold out
1975
+ message: Product 136307 was removed because it was sold out
1973
1976
  line_item_id: li_UkLWZg9DAJ
1974
1977
  variant_id: variant_UkLWZg9DAJ
1975
1978
  coupon_code:
@@ -2117,6 +2120,8 @@ paths:
2117
2120
  market_id: mkt_UkLWZg9DAJ
2118
2121
  channel_id: ch_UkLWZg9DAJ
2119
2122
  preferred_stock_location_id:
2123
+ company_id:
2124
+ company_name:
2120
2125
  number: cart_UkLWZg9DAJ
2121
2126
  token: PMVmxRAiLqMivU5QgJqfpQMD
2122
2127
  email:
@@ -2177,8 +2182,8 @@ paths:
2177
2182
  preorder_ships_at:
2178
2183
  quantity: 1
2179
2184
  currency: USD
2180
- name: Product 1293263
2181
- slug: product-1293263
2185
+ name: Product 1373263
2186
+ slug: product-1373263
2182
2187
  options_text: ''
2183
2188
  price: '10.0'
2184
2189
  display_price: "$10.00"
@@ -2396,6 +2401,8 @@ paths:
2396
2401
  market_id: mkt_UkLWZg9DAJ
2397
2402
  channel_id: ch_UkLWZg9DAJ
2398
2403
  preferred_stock_location_id:
2404
+ company_id:
2405
+ company_name:
2399
2406
  number: cart_UkLWZg9DAJ
2400
2407
  token: rrGvkDXx3KcQVwLVk8XiVCVk
2401
2408
  email: tarah@tromp.com
@@ -2453,8 +2460,8 @@ paths:
2453
2460
  preorder_ships_at:
2454
2461
  quantity: 1
2455
2462
  currency: USD
2456
- name: Product 1318992
2457
- slug: product-1318992
2463
+ name: Product 1398992
2464
+ slug: product-1398992
2458
2465
  options_text: ''
2459
2466
  price: '10.0'
2460
2467
  display_price: "$10.00"
@@ -2481,6 +2488,7 @@ paths:
2481
2488
  payments: []
2482
2489
  billing_address:
2483
2490
  id: addr_gbHJdmfrXB
2491
+ label:
2484
2492
  first_name: John
2485
2493
  last_name: Doe
2486
2494
  full_name: John Doe
@@ -2502,6 +2510,7 @@ paths:
2502
2510
  state_name: New York
2503
2511
  shipping_address:
2504
2512
  id: addr_UkLWZg9DAJ
2513
+ label:
2505
2514
  first_name: John
2506
2515
  last_name: Doe
2507
2516
  full_name: John Doe
@@ -2612,6 +2621,8 @@ paths:
2612
2621
  market_id: mkt_UkLWZg9DAJ
2613
2622
  cart_id: cart_UkLWZg9DAJ
2614
2623
  channel_id: ch_UkLWZg9DAJ
2624
+ company_id:
2625
+ company_name:
2615
2626
  number: R1001
2616
2627
  email: marvel@bruen.com
2617
2628
  customer_note:
@@ -2657,8 +2668,8 @@ paths:
2657
2668
  preorder_ships_at:
2658
2669
  quantity: 1
2659
2670
  currency: USD
2660
- name: Product 1344794
2661
- slug: product-1344794
2671
+ name: Product 1424794
2672
+ slug: product-1424794
2662
2673
  options_text: ''
2663
2674
  price: '10.0'
2664
2675
  display_price: "$10.00"
@@ -2788,6 +2799,7 @@ paths:
2788
2799
  source_required: false
2789
2800
  billing_address:
2790
2801
  id: addr_uw2YK1rnl0
2802
+ label:
2791
2803
  first_name: John
2792
2804
  last_name: Doe
2793
2805
  full_name: John Doe
@@ -2809,6 +2821,7 @@ paths:
2809
2821
  state_name: New York
2810
2822
  shipping_address:
2811
2823
  id: addr_OIJLhNcSbf
2824
+ label:
2812
2825
  first_name: John
2813
2826
  last_name: Doe
2814
2827
  full_name: John Doe
@@ -2923,6 +2936,8 @@ paths:
2923
2936
  market_id: mkt_UkLWZg9DAJ
2924
2937
  channel_id: ch_UkLWZg9DAJ
2925
2938
  preferred_stock_location_id:
2939
+ company_id:
2940
+ company_name:
2926
2941
  number: cart_UkLWZg9DAJ
2927
2942
  token: 4ryA4ms4Nim9TfxNW4fZi3au
2928
2943
  email:
@@ -2986,8 +3001,8 @@ paths:
2986
3001
  preorder_ships_at:
2987
3002
  quantity: 1
2988
3003
  currency: USD
2989
- name: Product 1604241
2990
- slug: product-1604241
3004
+ name: Product 1694241
3005
+ slug: product-1694241
2991
3006
  options_text: ''
2992
3007
  price: '10.0'
2993
3008
  display_price: "$10.00"
@@ -3115,6 +3130,8 @@ paths:
3115
3130
  market_id: mkt_UkLWZg9DAJ
3116
3131
  channel_id: ch_UkLWZg9DAJ
3117
3132
  preferred_stock_location_id:
3133
+ company_id:
3134
+ company_name:
3118
3135
  number: cart_UkLWZg9DAJ
3119
3136
  token: gvr8TwNVJpxWf27uUHDj5Lj4
3120
3137
  email:
@@ -3175,8 +3192,8 @@ paths:
3175
3192
  preorder_ships_at:
3176
3193
  quantity: 1
3177
3194
  currency: USD
3178
- name: Product 1623461
3179
- slug: product-1623461
3195
+ name: Product 1713461
3196
+ slug: product-1713461
3180
3197
  options_text: ''
3181
3198
  price: '10.0'
3182
3199
  display_price: "$10.00"
@@ -3249,11 +3266,16 @@ paths:
3249
3266
  publishableKey: '<api-key>',
3250
3267
  })
3251
3268
 
3252
- const cart = await client.carts.fulfillments.update('cart_abc123', 'ful_abc123', {
3253
- selected_delivery_rate_id: 'dr_abc123',
3254
- }, {
3255
- token: '<token>',
3256
- })
3269
+ const cart = await client.carts.fulfillments.update(
3270
+ 'cart_abc123',
3271
+ 'ful_abc123',
3272
+ {
3273
+ selected_delivery_rate_id: 'dr_abc123',
3274
+ },
3275
+ {
3276
+ token: '<token>',
3277
+ },
3278
+ )
3257
3279
  parameters:
3258
3280
  - name: x-spree-api-key
3259
3281
  in: header
@@ -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 1648182
3351
- slug: product-1648182
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 1665702
3637
- slug: product-1665702
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 1709569
3881
- slug: product-1709569
3909
+ name: Product 1799569
3910
+ slug: product-1799569
3882
3911
  options_text: ''
3883
3912
  price: '10.0'
3884
3913
  display_price: "$10.00"
@@ -3966,12 +3995,16 @@ paths:
3966
3995
  publishableKey: '<api-key>',
3967
3996
  })
3968
3997
 
3969
- const cart = await client.carts.items.create('cart_abc123', {
3970
- variant_id: 'variant_abc123',
3971
- quantity: 2,
3972
- }, {
3973
- token: '<token>',
3974
- })
3998
+ const cart = await client.carts.items.create(
3999
+ 'cart_abc123',
4000
+ {
4001
+ variant_id: 'variant_abc123',
4002
+ quantity: 2,
4003
+ },
4004
+ {
4005
+ token: '<token>',
4006
+ },
4007
+ )
3975
4008
  parameters:
3976
4009
  - name: x-spree-api-key
3977
4010
  in: header
@@ -4012,6 +4045,8 @@ paths:
4012
4045
  market_id: mkt_UkLWZg9DAJ
4013
4046
  channel_id: ch_UkLWZg9DAJ
4014
4047
  preferred_stock_location_id:
4048
+ company_id:
4049
+ company_name:
4015
4050
  number: cart_UkLWZg9DAJ
4016
4051
  token: d12LXVnL3KtzGjXePqRawnPc
4017
4052
  email:
@@ -4021,10 +4056,10 @@ paths:
4021
4056
  total_quantity: 2
4022
4057
  warnings:
4023
4058
  - code: delivery_unavailable
4024
- message: Product 17363 cannot be delivered to the selected address
4059
+ message: Product 18263 cannot be delivered to the selected address
4025
4060
  line_item_id: li_UkLWZg9DAJ
4026
4061
  - code: delivery_unavailable
4027
- message: Product 174298 cannot be delivered to the selected address
4062
+ message: Product 183298 cannot be delivered to the selected address
4028
4063
  line_item_id: li_gbHJdmfrXB
4029
4064
  coupon_code:
4030
4065
  item_total: '29.99'
@@ -4078,8 +4113,8 @@ paths:
4078
4113
  preorder_ships_at:
4079
4114
  quantity: 1
4080
4115
  currency: USD
4081
- name: Product 17363
4082
- slug: product-17363
4116
+ name: Product 18263
4117
+ slug: product-18263
4083
4118
  options_text: ''
4084
4119
  price: '10.0'
4085
4120
  display_price: "$10.00"
@@ -4109,8 +4144,8 @@ paths:
4109
4144
  preorder_ships_at:
4110
4145
  quantity: 1
4111
4146
  currency: USD
4112
- name: Product 174298
4113
- slug: product-174298
4147
+ name: Product 183298
4148
+ slug: product-183298
4114
4149
  options_text: ''
4115
4150
  price: '19.99'
4116
4151
  display_price: "$19.99"
@@ -4217,11 +4252,16 @@ paths:
4217
4252
  publishableKey: '<api-key>',
4218
4253
  })
4219
4254
 
4220
- const cart = await client.carts.items.update('cart_abc123', 'li_abc123', {
4221
- quantity: 5,
4222
- }, {
4223
- token: '<token>',
4224
- })
4255
+ const cart = await client.carts.items.update(
4256
+ 'cart_abc123',
4257
+ 'li_abc123',
4258
+ {
4259
+ quantity: 5,
4260
+ },
4261
+ {
4262
+ token: '<token>',
4263
+ },
4264
+ )
4225
4265
  parameters:
4226
4266
  - name: x-spree-api-key
4227
4267
  in: header
@@ -4260,6 +4300,8 @@ paths:
4260
4300
  market_id: mkt_UkLWZg9DAJ
4261
4301
  channel_id: ch_UkLWZg9DAJ
4262
4302
  preferred_stock_location_id:
4303
+ company_id:
4304
+ company_name:
4263
4305
  number: cart_UkLWZg9DAJ
4264
4306
  token: Yq5XuZqq7KS7y7n2dMsChnZM
4265
4307
  email:
@@ -4324,8 +4366,8 @@ paths:
4324
4366
  preorder_ships_at:
4325
4367
  quantity: 1
4326
4368
  currency: USD
4327
- name: Product 1809165
4328
- slug: product-1809165
4369
+ name: Product 1899165
4370
+ slug: product-1899165
4329
4371
  options_text: ''
4330
4372
  price: '10.0'
4331
4373
  display_price: "$10.00"
@@ -4442,6 +4484,8 @@ paths:
4442
4484
  market_id: mkt_UkLWZg9DAJ
4443
4485
  channel_id: ch_UkLWZg9DAJ
4444
4486
  preferred_stock_location_id:
4487
+ company_id:
4488
+ company_name:
4445
4489
  number: cart_UkLWZg9DAJ
4446
4490
  token: arTvbVzmU1krWKLbRnWDZ3cL
4447
4491
  email:
@@ -4542,11 +4586,15 @@ paths:
4542
4586
  publishableKey: '<api-key>',
4543
4587
  })
4544
4588
 
4545
- const session = await client.carts.paymentSessions.create('cart_abc123', {
4546
- payment_method_id: 'pm_abc123',
4547
- }, {
4548
- token: '<token>',
4549
- })
4589
+ const session = await client.carts.paymentSessions.create(
4590
+ 'cart_abc123',
4591
+ {
4592
+ payment_method_id: 'pm_abc123',
4593
+ },
4594
+ {
4595
+ token: '<token>',
4596
+ },
4597
+ )
4550
4598
  parameters:
4551
4599
  - name: x-spree-api-key
4552
4600
  in: header
@@ -4735,11 +4783,16 @@ paths:
4735
4783
  publishableKey: '<api-key>',
4736
4784
  })
4737
4785
 
4738
- const session = await client.carts.paymentSessions.update('cart_abc123', 'ps_abc123', {
4739
- amount: '50.00',
4740
- }, {
4741
- token: '<token>',
4742
- })
4786
+ const session = await client.carts.paymentSessions.update(
4787
+ 'cart_abc123',
4788
+ 'ps_abc123',
4789
+ {
4790
+ amount: '50.00',
4791
+ },
4792
+ {
4793
+ token: '<token>',
4794
+ },
4795
+ )
4743
4796
  parameters: []
4744
4797
  responses:
4745
4798
  '200':
@@ -4832,11 +4885,16 @@ paths:
4832
4885
  publishableKey: '<api-key>',
4833
4886
  })
4834
4887
 
4835
- const session = await client.carts.paymentSessions.complete('cart_abc123', 'ps_abc123', {
4836
- session_result: 'success',
4837
- }, {
4838
- token: '<token>',
4839
- })
4888
+ const session = await client.carts.paymentSessions.complete(
4889
+ 'cart_abc123',
4890
+ 'ps_abc123',
4891
+ {
4892
+ session_result: 'success',
4893
+ },
4894
+ {
4895
+ token: '<token>',
4896
+ },
4897
+ )
4840
4898
  parameters:
4841
4899
  - name: Idempotency-Key
4842
4900
  in: header
@@ -4915,11 +4973,15 @@ paths:
4915
4973
  publishableKey: '<api-key>',
4916
4974
  })
4917
4975
 
4918
- const payment = await client.carts.payments.create('cart_abc123', {
4919
- payment_method_id: 'pm_abc123',
4920
- }, {
4921
- token: '<token>',
4922
- })
4976
+ const payment = await client.carts.payments.create(
4977
+ 'cart_abc123',
4978
+ {
4979
+ payment_method_id: 'pm_abc123',
4980
+ },
4981
+ {
4982
+ token: '<token>',
4983
+ },
4984
+ )
4923
4985
  parameters:
4924
4986
  - name: x-spree-api-key
4925
4987
  in: header
@@ -5060,6 +5122,8 @@ paths:
5060
5122
  market_id: mkt_UkLWZg9DAJ
5061
5123
  channel_id: ch_UkLWZg9DAJ
5062
5124
  preferred_stock_location_id:
5125
+ company_id:
5126
+ company_name:
5063
5127
  number: cart_UkLWZg9DAJ
5064
5128
  token: acfBZtWemHae74Y3g18LQg1f
5065
5129
  email:
@@ -5116,8 +5180,8 @@ paths:
5116
5180
  preorder_ships_at:
5117
5181
  quantity: 1
5118
5182
  currency: USD
5119
- name: Product 2429789
5120
- slug: product-2429789
5183
+ name: Product 2519789
5184
+ slug: product-2519789
5121
5185
  options_text: ''
5122
5186
  price: '10.0'
5123
5187
  display_price: "$10.00"
@@ -5264,6 +5328,8 @@ paths:
5264
5328
  market_id: mkt_UkLWZg9DAJ
5265
5329
  channel_id: ch_UkLWZg9DAJ
5266
5330
  preferred_stock_location_id:
5331
+ company_id:
5332
+ company_name:
5267
5333
  number: cart_UkLWZg9DAJ
5268
5334
  token: BHWevnp2PQxC1jSWU3ZFLejT
5269
5335
  email:
@@ -5324,8 +5390,8 @@ paths:
5324
5390
  preorder_ships_at:
5325
5391
  quantity: 1
5326
5392
  currency: USD
5327
- name: Product 244179
5328
- slug: product-244179
5393
+ name: Product 253179
5394
+ slug: product-253179
5329
5395
  options_text: ''
5330
5396
  price: '10.0'
5331
5397
  display_price: "$10.00"
@@ -5388,9 +5454,13 @@ paths:
5388
5454
  publishableKey: '<api-key>',
5389
5455
  })
5390
5456
 
5391
- const order = await client.orders.get('or_abc123', {}, {
5392
- token: '<token>',
5393
- })
5457
+ const order = await client.orders.get(
5458
+ 'or_abc123',
5459
+ {},
5460
+ {
5461
+ token: '<token>',
5462
+ },
5463
+ )
5394
5464
  parameters:
5395
5465
  - name: x-spree-api-key
5396
5466
  in: header
@@ -5440,6 +5510,8 @@ paths:
5440
5510
  market_id: mkt_UkLWZg9DAJ
5441
5511
  cart_id:
5442
5512
  channel_id: ch_UkLWZg9DAJ
5513
+ company_id:
5514
+ company_name:
5443
5515
  number: R1001
5444
5516
  email: guest@example.com
5445
5517
  customer_note:
@@ -5485,8 +5557,8 @@ paths:
5485
5557
  preorder_ships_at:
5486
5558
  quantity: 1
5487
5559
  currency: USD
5488
- name: Product 184496
5489
- slug: product-184496
5560
+ name: Product 193496
5561
+ slug: product-193496
5490
5562
  options_text: ''
5491
5563
  price: '10.0'
5492
5564
  display_price: "$10.00"
@@ -5591,10 +5663,11 @@ paths:
5591
5663
  payments: []
5592
5664
  billing_address:
5593
5665
  id: addr_UkLWZg9DAJ
5666
+ label:
5594
5667
  first_name: John
5595
5668
  last_name: Doe
5596
5669
  full_name: John Doe
5597
- address1: 255 Lovely Street
5670
+ address1: 282 Lovely Street
5598
5671
  address2: Northwest
5599
5672
  postal_code: '10118'
5600
5673
  city: New York
@@ -5612,10 +5685,11 @@ paths:
5612
5685
  state_name: New York
5613
5686
  shipping_address:
5614
5687
  id: addr_gbHJdmfrXB
5688
+ label:
5615
5689
  first_name: John
5616
5690
  last_name: Doe
5617
5691
  full_name: John Doe
5618
- address1: 256 Lovely Street
5692
+ address1: 283 Lovely Street
5619
5693
  address2: Northwest
5620
5694
  postal_code: '10118'
5621
5695
  city: New York
@@ -5675,9 +5749,12 @@ paths:
5675
5749
  publishableKey: '<api-key>',
5676
5750
  })
5677
5751
 
5678
- const addresses = await client.customer.addresses.list({}, {
5679
- token: '<token>',
5680
- })
5752
+ const addresses = await client.customer.addresses.list(
5753
+ {},
5754
+ {
5755
+ token: '<token>',
5756
+ },
5757
+ )
5681
5758
  parameters:
5682
5759
  - name: x-spree-api-key
5683
5760
  in: header
@@ -5714,6 +5791,7 @@ paths:
5714
5791
  example:
5715
5792
  data:
5716
5793
  - id: addr_UkLWZg9DAJ
5794
+ label:
5717
5795
  first_name: John
5718
5796
  last_name: Doe
5719
5797
  full_name: John Doe
@@ -5734,6 +5812,7 @@ paths:
5734
5812
  country_iso: US
5735
5813
  state_name: New York
5736
5814
  - id: addr_gbHJdmfrXB
5815
+ label:
5737
5816
  first_name: John
5738
5817
  last_name: Doe
5739
5818
  full_name: John Doe
@@ -5754,6 +5833,7 @@ paths:
5754
5833
  country_iso: US
5755
5834
  state_name: New York
5756
5835
  - id: addr_EfhxLZ9ck8
5836
+ label:
5757
5837
  first_name: John
5758
5838
  last_name: Doe
5759
5839
  full_name: John Doe
@@ -5854,6 +5934,7 @@ paths:
5854
5934
  application/json:
5855
5935
  example:
5856
5936
  id: addr_VqXmZF31wY
5937
+ label:
5857
5938
  first_name: John
5858
5939
  last_name: Doe
5859
5940
  full_name: John Doe
@@ -6010,6 +6091,7 @@ paths:
6010
6091
  application/json:
6011
6092
  example:
6012
6093
  id: addr_EfhxLZ9ck8
6094
+ label:
6013
6095
  first_name: John
6014
6096
  last_name: Doe
6015
6097
  full_name: John Doe
@@ -6059,11 +6141,15 @@ paths:
6059
6141
  publishableKey: '<api-key>',
6060
6142
  })
6061
6143
 
6062
- const address = await client.customer.addresses.update('addr_abc123', {
6063
- city: 'Los Angeles',
6064
- }, {
6065
- token: '<token>',
6066
- })
6144
+ const address = await client.customer.addresses.update(
6145
+ 'addr_abc123',
6146
+ {
6147
+ city: 'Los Angeles',
6148
+ },
6149
+ {
6150
+ token: '<token>',
6151
+ },
6152
+ )
6067
6153
  parameters:
6068
6154
  - name: x-spree-api-key
6069
6155
  in: header
@@ -6087,6 +6173,7 @@ paths:
6087
6173
  application/json:
6088
6174
  example:
6089
6175
  id: addr_EfhxLZ9ck8
6176
+ label:
6090
6177
  first_name: John
6091
6178
  last_name: Doe
6092
6179
  full_name: John Doe
@@ -6205,9 +6292,12 @@ paths:
6205
6292
  publishableKey: '<api-key>',
6206
6293
  })
6207
6294
 
6208
- const cards = await client.customer.creditCards.list({}, {
6209
- token: '<token>',
6210
- })
6295
+ const cards = await client.customer.creditCards.list(
6296
+ {},
6297
+ {
6298
+ token: '<token>',
6299
+ },
6300
+ )
6211
6301
  parameters:
6212
6302
  - name: x-spree-api-key
6213
6303
  in: header
@@ -6530,6 +6620,8 @@ paths:
6530
6620
  market_id: mkt_UkLWZg9DAJ
6531
6621
  cart_id:
6532
6622
  channel_id: ch_UkLWZg9DAJ
6623
+ company_id:
6624
+ company_name:
6533
6625
  number: R1001
6534
6626
  email: idella.ratke@runolfsdottir.us
6535
6627
  customer_note:
@@ -6575,8 +6667,8 @@ paths:
6575
6667
  preorder_ships_at:
6576
6668
  quantity: 1
6577
6669
  currency: USD
6578
- name: Product 1505270
6579
- slug: product-1505270
6670
+ name: Product 1595270
6671
+ slug: product-1595270
6580
6672
  options_text: ''
6581
6673
  price: '10.0'
6582
6674
  display_price: "$10.00"
@@ -6681,10 +6773,11 @@ paths:
6681
6773
  payments: []
6682
6774
  billing_address:
6683
6775
  id: addr_EfhxLZ9ck8
6776
+ label:
6684
6777
  first_name: John
6685
6778
  last_name: Doe
6686
6779
  full_name: John Doe
6687
- address1: 159 Lovely Street
6780
+ address1: 186 Lovely Street
6688
6781
  address2: Northwest
6689
6782
  postal_code: '10118'
6690
6783
  city: New York
@@ -6702,10 +6795,11 @@ paths:
6702
6795
  state_name: New York
6703
6796
  shipping_address:
6704
6797
  id: addr_VqXmZF31wY
6798
+ label:
6705
6799
  first_name: John
6706
6800
  last_name: Doe
6707
6801
  full_name: John Doe
6708
- address1: 160 Lovely Street
6802
+ address1: 187 Lovely Street
6709
6803
  address2: Northwest
6710
6804
  postal_code: '10118'
6711
6805
  city: New York
@@ -6785,9 +6879,13 @@ paths:
6785
6879
  publishableKey: '<api-key>',
6786
6880
  })
6787
6881
 
6788
- const order = await client.customer.orders.get('or_abc123', {}, {
6789
- token: '<token>',
6790
- })
6882
+ const order = await client.customer.orders.get(
6883
+ 'or_abc123',
6884
+ {},
6885
+ {
6886
+ token: '<token>',
6887
+ },
6888
+ )
6791
6889
  parameters:
6792
6890
  - name: x-spree-api-key
6793
6891
  in: header
@@ -6830,6 +6928,8 @@ paths:
6830
6928
  market_id: mkt_UkLWZg9DAJ
6831
6929
  cart_id:
6832
6930
  channel_id: ch_UkLWZg9DAJ
6931
+ company_id:
6932
+ company_name:
6833
6933
  number: R1001
6834
6934
  email: whitney_homenick@leschwhite.co.uk
6835
6935
  customer_note:
@@ -6875,8 +6975,8 @@ paths:
6875
6975
  preorder_ships_at:
6876
6976
  quantity: 1
6877
6977
  currency: USD
6878
- name: Product 1525633
6879
- slug: product-1525633
6978
+ name: Product 1615633
6979
+ slug: product-1615633
6880
6980
  options_text: ''
6881
6981
  price: '10.0'
6882
6982
  display_price: "$10.00"
@@ -6981,10 +7081,11 @@ paths:
6981
7081
  payments: []
6982
7082
  billing_address:
6983
7083
  id: addr_EfhxLZ9ck8
7084
+ label:
6984
7085
  first_name: John
6985
7086
  last_name: Doe
6986
7087
  full_name: John Doe
6987
- address1: 165 Lovely Street
7088
+ address1: 192 Lovely Street
6988
7089
  address2: Northwest
6989
7090
  postal_code: '10118'
6990
7091
  city: New York
@@ -7002,10 +7103,11 @@ paths:
7002
7103
  state_name: New York
7003
7104
  shipping_address:
7004
7105
  id: addr_VqXmZF31wY
7106
+ label:
7005
7107
  first_name: John
7006
7108
  last_name: Doe
7007
7109
  full_name: John Doe
7008
- address1: 166 Lovely Street
7110
+ address1: 193 Lovely Street
7009
7111
  address2: Northwest
7010
7112
  postal_code: '10118'
7011
7113
  city: New York
@@ -7220,10 +7322,11 @@ paths:
7220
7322
  display_available_store_credit_total: "$0.00"
7221
7323
  addresses:
7222
7324
  - id: addr_UkLWZg9DAJ
7325
+ label:
7223
7326
  first_name: John
7224
7327
  last_name: Doe
7225
7328
  full_name: John Doe
7226
- address1: 171 Lovely Street
7329
+ address1: 198 Lovely Street
7227
7330
  address2: Northwest
7228
7331
  postal_code: '10118'
7229
7332
  city: New York
@@ -7240,10 +7343,11 @@ paths:
7240
7343
  country_iso: US
7241
7344
  state_name: New York
7242
7345
  - id: addr_gbHJdmfrXB
7346
+ label:
7243
7347
  first_name: John
7244
7348
  last_name: Doe
7245
7349
  full_name: John Doe
7246
- address1: 172 Lovely Street
7350
+ address1: 199 Lovely Street
7247
7351
  address2: Northwest
7248
7352
  postal_code: '10118'
7249
7353
  city: New York
@@ -7261,10 +7365,11 @@ paths:
7261
7365
  state_name: New York
7262
7366
  default_billing_address:
7263
7367
  id: addr_gbHJdmfrXB
7368
+ label:
7264
7369
  first_name: John
7265
7370
  last_name: Doe
7266
7371
  full_name: John Doe
7267
- address1: 172 Lovely Street
7372
+ address1: 199 Lovely Street
7268
7373
  address2: Northwest
7269
7374
  postal_code: '10118'
7270
7375
  city: New York
@@ -7282,10 +7387,11 @@ paths:
7282
7387
  state_name: New York
7283
7388
  default_shipping_address:
7284
7389
  id: addr_UkLWZg9DAJ
7390
+ label:
7285
7391
  first_name: John
7286
7392
  last_name: Doe
7287
7393
  full_name: John Doe
7288
- address1: 171 Lovely Street
7394
+ address1: 198 Lovely Street
7289
7395
  address2: Northwest
7290
7396
  postal_code: '10118'
7291
7397
  city: New York
@@ -7334,13 +7440,16 @@ paths:
7334
7440
  publishableKey: '<api-key>',
7335
7441
  })
7336
7442
 
7337
- const customer = await client.customer.update({
7338
- first_name: 'John',
7339
- last_name: 'Doe',
7340
- metadata: { preferred_contact: 'email' },
7341
- }, {
7342
- token: '<token>',
7343
- })
7443
+ const customer = await client.customer.update(
7444
+ {
7445
+ first_name: 'John',
7446
+ last_name: 'Doe',
7447
+ metadata: { preferred_contact: 'email' },
7448
+ },
7449
+ {
7450
+ token: '<token>',
7451
+ },
7452
+ )
7344
7453
  parameters:
7345
7454
  - name: x-spree-api-key
7346
7455
  in: header
@@ -7369,10 +7478,11 @@ paths:
7369
7478
  display_available_store_credit_total: "$0.00"
7370
7479
  addresses:
7371
7480
  - id: addr_UkLWZg9DAJ
7481
+ label:
7372
7482
  first_name: John
7373
7483
  last_name: Doe
7374
7484
  full_name: John Doe
7375
- address1: 173 Lovely Street
7485
+ address1: 200 Lovely Street
7376
7486
  address2: Northwest
7377
7487
  postal_code: '10118'
7378
7488
  city: New York
@@ -7389,10 +7499,11 @@ paths:
7389
7499
  country_iso: US
7390
7500
  state_name: New York
7391
7501
  - id: addr_gbHJdmfrXB
7502
+ label:
7392
7503
  first_name: John
7393
7504
  last_name: Doe
7394
7505
  full_name: John Doe
7395
- address1: 174 Lovely Street
7506
+ address1: 201 Lovely Street
7396
7507
  address2: Northwest
7397
7508
  postal_code: '10118'
7398
7509
  city: New York
@@ -7410,10 +7521,11 @@ paths:
7410
7521
  state_name: New York
7411
7522
  default_billing_address:
7412
7523
  id: addr_gbHJdmfrXB
7524
+ label:
7413
7525
  first_name: John
7414
7526
  last_name: Doe
7415
7527
  full_name: John Doe
7416
- address1: 174 Lovely Street
7528
+ address1: 201 Lovely Street
7417
7529
  address2: Northwest
7418
7530
  postal_code: '10118'
7419
7531
  city: New York
@@ -7431,10 +7543,11 @@ paths:
7431
7543
  state_name: New York
7432
7544
  default_shipping_address:
7433
7545
  id: addr_UkLWZg9DAJ
7546
+ label:
7434
7547
  first_name: John
7435
7548
  last_name: Doe
7436
7549
  full_name: John Doe
7437
- address1: 173 Lovely Street
7550
+ address1: 200 Lovely Street
7438
7551
  address2: Northwest
7439
7552
  postal_code: '10118'
7440
7553
  city: New York
@@ -7519,9 +7632,12 @@ paths:
7519
7632
  publishableKey: '<api-key>',
7520
7633
  })
7521
7634
 
7522
- const giftCards = await client.customer.giftCards.list({}, {
7523
- token: '<token>',
7524
- })
7635
+ const giftCards = await client.customer.giftCards.list(
7636
+ {},
7637
+ {
7638
+ token: '<token>',
7639
+ },
7640
+ )
7525
7641
  parameters:
7526
7642
  - name: x-spree-api-key
7527
7643
  in: header
@@ -7702,11 +7818,14 @@ paths:
7702
7818
  publishableKey: '<api-key>',
7703
7819
  })
7704
7820
 
7705
- const session = await client.customer.paymentSetupSessions.create({
7706
- payment_method_id: 'pm_abc123',
7707
- }, {
7708
- token: '<token>',
7709
- })
7821
+ const session = await client.customer.paymentSetupSessions.create(
7822
+ {
7823
+ payment_method_id: 'pm_abc123',
7824
+ },
7825
+ {
7826
+ token: '<token>',
7827
+ },
7828
+ )
7710
7829
  parameters:
7711
7830
  - name: x-spree-api-key
7712
7831
  in: header
@@ -7891,9 +8010,13 @@ paths:
7891
8010
  publishableKey: '<api-key>',
7892
8011
  })
7893
8012
 
7894
- const session = await client.customer.paymentSetupSessions.complete('pss_abc123', {}, {
7895
- token: '<token>',
7896
- })
8013
+ const session = await client.customer.paymentSetupSessions.complete(
8014
+ 'pss_abc123',
8015
+ {},
8016
+ {
8017
+ token: '<token>',
8018
+ },
8019
+ )
7897
8020
  parameters: []
7898
8021
  responses:
7899
8022
  '200':
@@ -7960,9 +8083,12 @@ paths:
7960
8083
  publishableKey: '<api-key>',
7961
8084
  })
7962
8085
 
7963
- const credits = await client.customer.storeCredits.list({}, {
7964
- token: '<token>',
7965
- })
8086
+ const credits = await client.customer.storeCredits.list(
8087
+ {},
8088
+ {
8089
+ token: '<token>',
8090
+ },
8091
+ )
7966
8092
  parameters:
7967
8093
  - name: x-spree-api-key
7968
8094
  in: header
@@ -8808,9 +8934,12 @@ paths:
8808
8934
  publishableKey: '<api-key>',
8809
8935
  })
8810
8936
 
8811
- const wishlists = await client.wishlists.list({}, {
8812
- token: '<token>',
8813
- })
8937
+ const wishlists = await client.wishlists.list(
8938
+ {},
8939
+ {
8940
+ token: '<token>',
8941
+ },
8942
+ )
8814
8943
  parameters:
8815
8944
  - name: x-spree-api-key
8816
8945
  in: header
@@ -8899,12 +9028,15 @@ paths:
8899
9028
  publishableKey: '<api-key>',
8900
9029
  })
8901
9030
 
8902
- const wishlist = await client.wishlists.create({
8903
- name: 'Birthday Ideas',
8904
- is_private: true,
8905
- }, {
8906
- token: '<token>',
8907
- })
9031
+ const wishlist = await client.wishlists.create(
9032
+ {
9033
+ name: 'Birthday Ideas',
9034
+ is_private: true,
9035
+ },
9036
+ {
9037
+ token: '<token>',
9038
+ },
9039
+ )
8908
9040
  parameters:
8909
9041
  - name: x-spree-api-key
8910
9042
  in: header
@@ -9058,11 +9190,15 @@ paths:
9058
9190
  publishableKey: '<api-key>',
9059
9191
  })
9060
9192
 
9061
- const wishlist = await client.wishlists.update('wl_abc123', {
9062
- name: 'Updated Name',
9063
- }, {
9064
- token: '<token>',
9065
- })
9193
+ const wishlist = await client.wishlists.update(
9194
+ 'wl_abc123',
9195
+ {
9196
+ name: 'Updated Name',
9197
+ },
9198
+ {
9199
+ token: '<token>',
9200
+ },
9201
+ )
9066
9202
  parameters:
9067
9203
  - name: x-spree-api-key
9068
9204
  in: header
@@ -9167,12 +9303,16 @@ paths:
9167
9303
  publishableKey: '<api-key>',
9168
9304
  })
9169
9305
 
9170
- const item = await client.wishlists.items.create('wl_abc123', {
9171
- variant_id: 'variant_abc123',
9172
- quantity: 1,
9173
- }, {
9174
- token: '<token>',
9175
- })
9306
+ const item = await client.wishlists.items.create(
9307
+ 'wl_abc123',
9308
+ {
9309
+ variant_id: 'variant_abc123',
9310
+ quantity: 1,
9311
+ },
9312
+ {
9313
+ token: '<token>',
9314
+ },
9315
+ )
9176
9316
  parameters:
9177
9317
  - name: x-spree-api-key
9178
9318
  in: header
@@ -9203,7 +9343,7 @@ paths:
9203
9343
  variant:
9204
9344
  id: variant_gbHJdmfrXB
9205
9345
  product_id: prod_gbHJdmfrXB
9206
- sku: SKU-298
9346
+ sku: SKU-307
9207
9347
  options_text: ''
9208
9348
  track_inventory: true
9209
9349
  media_count: 0
@@ -9852,15 +9992,18 @@ paths:
9852
9992
  message: Valid API key required
9853
9993
  schema:
9854
9994
  "$ref": "#/components/schemas/ErrorResponse"
9855
- "/api/v3/store/delivery_methods":
9995
+ "/api/v3/store/account/companies":
9856
9996
  get:
9857
- summary: List delivery methods
9997
+ summary: List my company memberships
9858
9998
  tags:
9859
- - Delivery
9999
+ - Companies
9860
10000
  security:
9861
10001
  - api_key: []
9862
- description: Storefront-visible delivery methods. Filter by fulfillment_type
9863
- 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.
9864
10007
  x-codeSamples:
9865
10008
  - lang: javascript
9866
10009
  label: Spree SDK
@@ -9872,56 +10015,63 @@ paths:
9872
10015
  publishableKey: '<api-key>',
9873
10016
  })
9874
10017
 
9875
- const { data: pickupMethods } = await client.deliveryMethods.list({
9876
- fulfillment_type: 'pickup',
9877
- })
10018
+ // The buyer's memberships, each carrying its node and the path above it.
10019
+ const { data: memberships } = await client.account.companies({ token: '<token>' })
9878
10020
  parameters:
9879
10021
  - name: x-spree-api-key
9880
10022
  in: header
9881
10023
  required: true
9882
10024
  schema:
9883
10025
  type: string
9884
- - name: fulfillment_type
9885
- in: query
9886
- required: false
9887
- description: 'Filter: shipping, digital, pickup'
10026
+ - name: Authorization
10027
+ in: header
10028
+ required: true
9888
10029
  schema:
9889
10030
  type: string
9890
10031
  responses:
9891
10032
  '200':
9892
- description: delivery methods found
10033
+ description: memberships listed
9893
10034
  content:
9894
10035
  application/json:
9895
10036
  example:
9896
10037
  data:
9897
- - id: dm_gbHJdmfrXB
9898
- name: Store pickup
9899
- code: PICKUP
9900
- estimated_transit_business_days_min:
9901
- estimated_transit_business_days_max:
9902
- digital: false
9903
- pickup: true
9904
- pickup_point: false
9905
- meta:
9906
- page: 1
9907
- limit: 25
9908
- count: 1
9909
- pages: 1
9910
- from: 1
9911
- to: 1
9912
- in: 1
9913
- previous:
9914
- next:
9915
- "/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
9916
10064
  get:
9917
- summary: List pickup locations
10065
+ summary: Get a company node
9918
10066
  tags:
9919
- - Delivery
10067
+ - Companies
9920
10068
  security:
9921
10069
  - api_key: []
9922
- description: Pickup-enabled stock locations for a pickup delivery method. Pass
9923
- cart_id to keep only locations that can fulfill the whole cart from local
9924
- 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.
9925
10075
  x-codeSamples:
9926
10076
  - lang: javascript
9927
10077
  label: Spree SDK
@@ -9933,19 +10083,851 @@ paths:
9933
10083
  publishableKey: '<api-key>',
9934
10084
  })
9935
10085
 
9936
- const { data: pickupLocations } = await client.deliveryMethods.pickupLocations('dm_abc123', {
9937
- cart_id: 'cart_abc123',
9938
- })
10086
+ const company = await client.companies.get('comp_86Rf07xd4z', { token: '<token>' })
9939
10087
  parameters:
9940
10088
  - name: x-spree-api-key
9941
10089
  in: header
9942
10090
  required: true
9943
10091
  schema:
9944
10092
  type: string
9945
- - name: id
9946
- in: path
10093
+ - name: Authorization
10094
+ in: header
9947
10095
  required: true
9948
- description: Delivery method prefixed ID
10096
+ schema:
10097
+ type: string
10098
+ responses:
10099
+ '200':
10100
+ description: company found
10101
+ content:
10102
+ application/json:
10103
+ example:
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
10119
+ tags:
10120
+ - Companies
10121
+ security:
10122
+ - api_key: []
10123
+ bearer_auth: []
10124
+ description: Renames the node. Structure — the parent and the kind — is managed
10125
+ by the merchant, not by buyers.
10126
+ parameters:
10127
+ - name: x-spree-api-key
10128
+ in: header
10129
+ required: true
10130
+ schema:
10131
+ type: string
10132
+ - name: Authorization
10133
+ in: header
10134
+ required: true
10135
+ schema:
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
10178
+ schema:
10179
+ type: string
10180
+ - name: Authorization
10181
+ in: header
10182
+ required: true
10183
+ schema:
10184
+ type: string
10185
+ responses:
10186
+ '200':
10187
+ description: members listed
10188
+ content:
10189
+ application/json:
10190
+ example:
10191
+ data:
10192
+ - id: cmem_UkLWZg9DAJ
10193
+ company_id: comp_UkLWZg9DAJ
10194
+ customer_id: cust_UkLWZg9DAJ
10195
+ email: su_kuvalis@ward.biz
10196
+ meta:
10197
+ page: 1
10198
+ limit: 25
10199
+ count: 1
10200
+ pages: 1
10201
+ from: 1
10202
+ to: 1
10203
+ in: 1
10204
+ previous:
10205
+ next:
10206
+ post:
10207
+ summary: Add a member by email
10208
+ tags:
10209
+ - Companies
10210
+ security:
10211
+ - api_key: []
10212
+ bearer_auth: []
10213
+ description: |
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'
10222
+
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
+ )
10235
+ parameters:
10236
+ - name: x-spree-api-key
10237
+ in: header
10238
+ required: true
10239
+ schema:
10240
+ type: string
10241
+ - name: Authorization
10242
+ in: header
10243
+ required: true
10244
+ schema:
10245
+ type: string
10246
+ responses:
10247
+ '201':
10248
+ description: member added or invitation sent
10249
+ content:
10250
+ application/json:
10251
+ example:
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
9949
10931
  schema:
9950
10932
  type: string
9951
10933
  - name: cart_id
@@ -10482,6 +11464,9 @@ components:
10482
11464
  properties:
10483
11465
  id:
10484
11466
  type: string
11467
+ label:
11468
+ type: string
11469
+ nullable: true
10485
11470
  first_name:
10486
11471
  type: string
10487
11472
  nullable: true
@@ -10534,6 +11519,7 @@ components:
10534
11519
  nullable: true
10535
11520
  required:
10536
11521
  - id
11522
+ - label
10537
11523
  - first_name
10538
11524
  - last_name
10539
11525
  - full_name
@@ -10606,6 +11592,12 @@ components:
10606
11592
  preferred_stock_location_id:
10607
11593
  type: string
10608
11594
  nullable: true
11595
+ company_id:
11596
+ type: string
11597
+ nullable: true
11598
+ company_name:
11599
+ type: string
11600
+ nullable: true
10609
11601
  number:
10610
11602
  type: string
10611
11603
  token:
@@ -10761,6 +11753,8 @@ components:
10761
11753
  - market_id
10762
11754
  - channel_id
10763
11755
  - preferred_stock_location_id
11756
+ - company_id
11757
+ - company_name
10764
11758
  - number
10765
11759
  - token
10766
11760
  - email
@@ -11074,6 +12068,66 @@ components:
11074
12068
  - image_url
11075
12069
  - square_image_url
11076
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
11077
12131
  Country:
11078
12132
  type: object
11079
12133
  properties:
@@ -12255,6 +13309,12 @@ components:
12255
13309
  channel_id:
12256
13310
  type: string
12257
13311
  nullable: true
13312
+ company_id:
13313
+ type: string
13314
+ nullable: true
13315
+ company_name:
13316
+ type: string
13317
+ nullable: true
12258
13318
  number:
12259
13319
  type: string
12260
13320
  email:
@@ -12396,6 +13456,8 @@ components:
12396
13456
  - market_id
12397
13457
  - cart_id
12398
13458
  - channel_id
13459
+ - company_id
13460
+ - company_name
12399
13461
  - number
12400
13462
  - email
12401
13463
  - customer_note