@spree/docs 0.1.51 → 0.1.53
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.
|
@@ -61,7 +61,7 @@ paths:
|
|
|
61
61
|
})
|
|
62
62
|
|
|
63
63
|
const addresses = await client.customer.addresses.list({}, {
|
|
64
|
-
|
|
64
|
+
token: '<token>',
|
|
65
65
|
})
|
|
66
66
|
parameters:
|
|
67
67
|
- name: x-spree-api-key
|
|
@@ -102,7 +102,7 @@ paths:
|
|
|
102
102
|
first_name: John
|
|
103
103
|
last_name: Doe
|
|
104
104
|
full_name: John Doe
|
|
105
|
-
address1:
|
|
105
|
+
address1: 72 Lovely Street
|
|
106
106
|
address2: Northwest
|
|
107
107
|
postal_code: '10118'
|
|
108
108
|
city: New York
|
|
@@ -120,7 +120,7 @@ paths:
|
|
|
120
120
|
first_name: John
|
|
121
121
|
last_name: Doe
|
|
122
122
|
full_name: John Doe
|
|
123
|
-
address1:
|
|
123
|
+
address1: 71 Lovely Street
|
|
124
124
|
address2: Northwest
|
|
125
125
|
postal_code: '10118'
|
|
126
126
|
city: New York
|
|
@@ -138,7 +138,7 @@ paths:
|
|
|
138
138
|
first_name: John
|
|
139
139
|
last_name: Doe
|
|
140
140
|
full_name: John Doe
|
|
141
|
-
address1:
|
|
141
|
+
address1: 70 Lovely Street
|
|
142
142
|
address2: Northwest
|
|
143
143
|
postal_code: '10118'
|
|
144
144
|
city: New York
|
|
@@ -210,7 +210,7 @@ paths:
|
|
|
210
210
|
state_abbr: 'NY',
|
|
211
211
|
phone: '+1 555 123 4567',
|
|
212
212
|
}, {
|
|
213
|
-
|
|
213
|
+
token: '<token>',
|
|
214
214
|
})
|
|
215
215
|
parameters:
|
|
216
216
|
- name: x-spree-api-key
|
|
@@ -352,7 +352,7 @@ paths:
|
|
|
352
352
|
})
|
|
353
353
|
|
|
354
354
|
const address = await client.customer.addresses.get('addr_abc123', {
|
|
355
|
-
|
|
355
|
+
token: '<token>',
|
|
356
356
|
})
|
|
357
357
|
parameters:
|
|
358
358
|
- name: x-spree-api-key
|
|
@@ -387,7 +387,7 @@ paths:
|
|
|
387
387
|
first_name: John
|
|
388
388
|
last_name: Doe
|
|
389
389
|
full_name: John Doe
|
|
390
|
-
address1:
|
|
390
|
+
address1: 84 Lovely Street
|
|
391
391
|
address2: Northwest
|
|
392
392
|
postal_code: '10118'
|
|
393
393
|
city: New York
|
|
@@ -434,7 +434,7 @@ paths:
|
|
|
434
434
|
const address = await client.customer.addresses.update('addr_abc123', {
|
|
435
435
|
city: 'Los Angeles',
|
|
436
436
|
}, {
|
|
437
|
-
|
|
437
|
+
token: '<token>',
|
|
438
438
|
})
|
|
439
439
|
parameters:
|
|
440
440
|
- name: x-spree-api-key
|
|
@@ -462,7 +462,7 @@ paths:
|
|
|
462
462
|
first_name: John
|
|
463
463
|
last_name: Doe
|
|
464
464
|
full_name: John Doe
|
|
465
|
-
address1:
|
|
465
|
+
address1: 90 Lovely Street
|
|
466
466
|
address2: Northwest
|
|
467
467
|
postal_code: '10118'
|
|
468
468
|
city: Los Angeles
|
|
@@ -523,7 +523,7 @@ paths:
|
|
|
523
523
|
})
|
|
524
524
|
|
|
525
525
|
await client.customer.addresses.delete('addr_abc123', {
|
|
526
|
-
|
|
526
|
+
token: '<token>',
|
|
527
527
|
})
|
|
528
528
|
parameters:
|
|
529
529
|
- name: x-spree-api-key
|
|
@@ -590,16 +590,16 @@ paths:
|
|
|
590
590
|
content:
|
|
591
591
|
application/json:
|
|
592
592
|
example:
|
|
593
|
-
token: eyJhbGciOiJIUzI1NiJ9.
|
|
594
|
-
refresh_token:
|
|
593
|
+
token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjUxYTNkYzFmLTU4ZDMtNDljYy05YWM1LWM2MDU4ZTAwZWM5OCIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc4NjExMzYwfQ.ot3K1sXKzYF-iqpT9YxE43jTnc7I8TNVV9EBzp00mQs
|
|
594
|
+
refresh_token: r7PoqWSU8MsALYQjsMYvbQag
|
|
595
595
|
user:
|
|
596
596
|
id: cus_UkLWZg9DAJ
|
|
597
597
|
email: test@example.com
|
|
598
|
-
first_name:
|
|
599
|
-
last_name:
|
|
598
|
+
first_name: Loura
|
|
599
|
+
last_name: Feeney
|
|
600
600
|
phone:
|
|
601
601
|
accepts_email_marketing: false
|
|
602
|
-
full_name:
|
|
602
|
+
full_name: Loura Feeney
|
|
603
603
|
available_store_credit_total: '0'
|
|
604
604
|
display_available_store_credit_total: "$0.00"
|
|
605
605
|
addresses: []
|
|
@@ -672,16 +672,16 @@ paths:
|
|
|
672
672
|
content:
|
|
673
673
|
application/json:
|
|
674
674
|
example:
|
|
675
|
-
token: eyJhbGciOiJIUzI1NiJ9.
|
|
676
|
-
refresh_token:
|
|
675
|
+
token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjA1ZThiZjI5LTkyYTMtNDE0MC1iMTBmLTJmNjY3MmNkMDAyZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc4NjExMzYyfQ.aJSxPoN9olUEyvx4x74fGWe3VMdYZqMJ6POEdyCU9vI
|
|
676
|
+
refresh_token: 3WdAHt6n5S8wbrYANgbFpfU8
|
|
677
677
|
user:
|
|
678
678
|
id: cus_UkLWZg9DAJ
|
|
679
679
|
email: test@example.com
|
|
680
|
-
first_name:
|
|
681
|
-
last_name:
|
|
680
|
+
first_name: Blanch
|
|
681
|
+
last_name: McGlynn
|
|
682
682
|
phone:
|
|
683
683
|
accepts_email_marketing: false
|
|
684
|
-
full_name:
|
|
684
|
+
full_name: Blanch McGlynn
|
|
685
685
|
available_store_credit_total: '0'
|
|
686
686
|
display_available_store_credit_total: "$0.00"
|
|
687
687
|
addresses: []
|
|
@@ -777,7 +777,7 @@ paths:
|
|
|
777
777
|
})
|
|
778
778
|
|
|
779
779
|
const carts = await client.carts.list({
|
|
780
|
-
|
|
780
|
+
token: '<token>',
|
|
781
781
|
})
|
|
782
782
|
parameters:
|
|
783
783
|
- name: x-spree-api-key
|
|
@@ -845,9 +845,9 @@ paths:
|
|
|
845
845
|
data:
|
|
846
846
|
- id: cart_gbHJdmfrXB
|
|
847
847
|
market_id:
|
|
848
|
-
number:
|
|
849
|
-
token:
|
|
850
|
-
email:
|
|
848
|
+
number: R853924202
|
|
849
|
+
token: U1F83NutEyK8WjZuprYpcDihaM9kWUbC2n8
|
|
850
|
+
email: jeffry.sanford@swiftmoen.name
|
|
851
851
|
customer_note:
|
|
852
852
|
currency: USD
|
|
853
853
|
locale: en
|
|
@@ -889,8 +889,8 @@ paths:
|
|
|
889
889
|
variant_id: variant_gbHJdmfrXB
|
|
890
890
|
quantity: 1
|
|
891
891
|
currency: USD
|
|
892
|
-
name: Product
|
|
893
|
-
slug: product-
|
|
892
|
+
name: Product 5869
|
|
893
|
+
slug: product-5869
|
|
894
894
|
options_text: ''
|
|
895
895
|
price: '10.0'
|
|
896
896
|
display_price: "$10.00"
|
|
@@ -915,7 +915,7 @@ paths:
|
|
|
915
915
|
digital_links: []
|
|
916
916
|
fulfillments:
|
|
917
917
|
- id: ful_gbHJdmfrXB
|
|
918
|
-
number:
|
|
918
|
+
number: H60441723661
|
|
919
919
|
tracking: U10000
|
|
920
920
|
tracking_url:
|
|
921
921
|
cost: '100.0'
|
|
@@ -944,7 +944,7 @@ paths:
|
|
|
944
944
|
stock_location:
|
|
945
945
|
id: sloc_UkLWZg9DAJ
|
|
946
946
|
state_abbr: NY
|
|
947
|
-
name:
|
|
947
|
+
name: Alana Champlin
|
|
948
948
|
address1: 1600 Pennsylvania Ave NW
|
|
949
949
|
city: Washington
|
|
950
950
|
zipcode: '20500'
|
|
@@ -976,7 +976,7 @@ paths:
|
|
|
976
976
|
first_name: John
|
|
977
977
|
last_name: Doe
|
|
978
978
|
full_name: John Doe
|
|
979
|
-
address1:
|
|
979
|
+
address1: 105 Lovely Street
|
|
980
980
|
address2: Northwest
|
|
981
981
|
postal_code: '10118'
|
|
982
982
|
city: New York
|
|
@@ -995,7 +995,7 @@ paths:
|
|
|
995
995
|
first_name: John
|
|
996
996
|
last_name: Doe
|
|
997
997
|
full_name: John Doe
|
|
998
|
-
address1:
|
|
998
|
+
address1: 106 Lovely Street
|
|
999
999
|
address2: Northwest
|
|
1000
1000
|
postal_code: '10118'
|
|
1001
1001
|
city: New York
|
|
@@ -1014,9 +1014,9 @@ paths:
|
|
|
1014
1014
|
market:
|
|
1015
1015
|
- id: cart_UkLWZg9DAJ
|
|
1016
1016
|
market_id:
|
|
1017
|
-
number:
|
|
1018
|
-
token:
|
|
1019
|
-
email:
|
|
1017
|
+
number: R372415977
|
|
1018
|
+
token: bcTYTX8ngzffV1iJvGw9bjjXSWxxNxuucLf
|
|
1019
|
+
email: jeffry.sanford@swiftmoen.name
|
|
1020
1020
|
customer_note:
|
|
1021
1021
|
currency: USD
|
|
1022
1022
|
locale: en
|
|
@@ -1058,8 +1058,8 @@ paths:
|
|
|
1058
1058
|
variant_id: variant_UkLWZg9DAJ
|
|
1059
1059
|
quantity: 1
|
|
1060
1060
|
currency: USD
|
|
1061
|
-
name: Product
|
|
1062
|
-
slug: product-
|
|
1061
|
+
name: Product 573191
|
|
1062
|
+
slug: product-573191
|
|
1063
1063
|
options_text: ''
|
|
1064
1064
|
price: '10.0'
|
|
1065
1065
|
display_price: "$10.00"
|
|
@@ -1084,7 +1084,7 @@ paths:
|
|
|
1084
1084
|
digital_links: []
|
|
1085
1085
|
fulfillments:
|
|
1086
1086
|
- id: ful_UkLWZg9DAJ
|
|
1087
|
-
number:
|
|
1087
|
+
number: H91506779163
|
|
1088
1088
|
tracking: U10000
|
|
1089
1089
|
tracking_url:
|
|
1090
1090
|
cost: '100.0'
|
|
@@ -1113,7 +1113,7 @@ paths:
|
|
|
1113
1113
|
stock_location:
|
|
1114
1114
|
id: sloc_UkLWZg9DAJ
|
|
1115
1115
|
state_abbr: NY
|
|
1116
|
-
name:
|
|
1116
|
+
name: Alana Champlin
|
|
1117
1117
|
address1: 1600 Pennsylvania Ave NW
|
|
1118
1118
|
city: Washington
|
|
1119
1119
|
zipcode: '20500'
|
|
@@ -1145,7 +1145,7 @@ paths:
|
|
|
1145
1145
|
first_name: John
|
|
1146
1146
|
last_name: Doe
|
|
1147
1147
|
full_name: John Doe
|
|
1148
|
-
address1:
|
|
1148
|
+
address1: 103 Lovely Street
|
|
1149
1149
|
address2: Northwest
|
|
1150
1150
|
postal_code: '10118'
|
|
1151
1151
|
city: New York
|
|
@@ -1164,7 +1164,7 @@ paths:
|
|
|
1164
1164
|
first_name: John
|
|
1165
1165
|
last_name: Doe
|
|
1166
1166
|
full_name: John Doe
|
|
1167
|
-
address1:
|
|
1167
|
+
address1: 104 Lovely Street
|
|
1168
1168
|
address2: Northwest
|
|
1169
1169
|
postal_code: '10118'
|
|
1170
1170
|
city: New York
|
|
@@ -1256,8 +1256,8 @@ paths:
|
|
|
1256
1256
|
example:
|
|
1257
1257
|
id: cart_UkLWZg9DAJ
|
|
1258
1258
|
market_id:
|
|
1259
|
-
number:
|
|
1260
|
-
token:
|
|
1259
|
+
number: R515839888
|
|
1260
|
+
token: TLybviD56Tpyj2WXzbuKuJcjYSQd3jpRKfS
|
|
1261
1261
|
email:
|
|
1262
1262
|
customer_note:
|
|
1263
1263
|
currency: USD
|
|
@@ -1365,7 +1365,7 @@ paths:
|
|
|
1365
1365
|
})
|
|
1366
1366
|
|
|
1367
1367
|
const cart = await client.carts.get('cart_abc123', {
|
|
1368
|
-
|
|
1368
|
+
token: '<token>',
|
|
1369
1369
|
})
|
|
1370
1370
|
parameters:
|
|
1371
1371
|
- name: x-spree-api-key
|
|
@@ -1412,9 +1412,9 @@ paths:
|
|
|
1412
1412
|
example:
|
|
1413
1413
|
id: cart_UkLWZg9DAJ
|
|
1414
1414
|
market_id:
|
|
1415
|
-
number:
|
|
1416
|
-
token:
|
|
1417
|
-
email:
|
|
1415
|
+
number: R269118078
|
|
1416
|
+
token: FXJmQ1HnGRPEjtyiPq1wVNY2AiJDK54Y8ZT
|
|
1417
|
+
email: chana@ledner.co.uk
|
|
1418
1418
|
customer_note:
|
|
1419
1419
|
currency: USD
|
|
1420
1420
|
locale: en
|
|
@@ -1441,7 +1441,7 @@ paths:
|
|
|
1441
1441
|
display_delivery_total: "$0.00"
|
|
1442
1442
|
warnings:
|
|
1443
1443
|
- code: line_item_removed
|
|
1444
|
-
message: Product
|
|
1444
|
+
message: Product 626630 was removed because it was sold out
|
|
1445
1445
|
line_item_id: li_UkLWZg9DAJ
|
|
1446
1446
|
variant_id: variant_UkLWZg9DAJ
|
|
1447
1447
|
store_credit_total: '0.0'
|
|
@@ -1466,7 +1466,7 @@ paths:
|
|
|
1466
1466
|
first_name: John
|
|
1467
1467
|
last_name: Doe
|
|
1468
1468
|
full_name: John Doe
|
|
1469
|
-
address1:
|
|
1469
|
+
address1: 113 Lovely Street
|
|
1470
1470
|
address2: Northwest
|
|
1471
1471
|
postal_code: '10118'
|
|
1472
1472
|
city: New York
|
|
@@ -1485,7 +1485,7 @@ paths:
|
|
|
1485
1485
|
first_name: John
|
|
1486
1486
|
last_name: Doe
|
|
1487
1487
|
full_name: John Doe
|
|
1488
|
-
address1:
|
|
1488
|
+
address1: 114 Lovely Street
|
|
1489
1489
|
address2: Northwest
|
|
1490
1490
|
postal_code: '10118'
|
|
1491
1491
|
city: New York
|
|
@@ -1546,7 +1546,7 @@ paths:
|
|
|
1546
1546
|
state_abbr: 'NY',
|
|
1547
1547
|
},
|
|
1548
1548
|
}, {
|
|
1549
|
-
|
|
1549
|
+
token: '<token>',
|
|
1550
1550
|
})
|
|
1551
1551
|
parameters:
|
|
1552
1552
|
- name: x-spree-api-key
|
|
@@ -1583,9 +1583,9 @@ paths:
|
|
|
1583
1583
|
example:
|
|
1584
1584
|
id: cart_UkLWZg9DAJ
|
|
1585
1585
|
market_id:
|
|
1586
|
-
number:
|
|
1587
|
-
token:
|
|
1588
|
-
email:
|
|
1586
|
+
number: R683996807
|
|
1587
|
+
token: hPjm4V8xfBVC6FsCozbroEBgL8MutEvZQBD
|
|
1588
|
+
email: alica_murray@marvin.com
|
|
1589
1589
|
customer_note: Leave at door
|
|
1590
1590
|
currency: USD
|
|
1591
1591
|
locale: en
|
|
@@ -1629,8 +1629,8 @@ paths:
|
|
|
1629
1629
|
variant_id: variant_UkLWZg9DAJ
|
|
1630
1630
|
quantity: 1
|
|
1631
1631
|
currency: USD
|
|
1632
|
-
name: Product
|
|
1633
|
-
slug: product-
|
|
1632
|
+
name: Product 634611
|
|
1633
|
+
slug: product-634611
|
|
1634
1634
|
options_text: ''
|
|
1635
1635
|
price: '19.99'
|
|
1636
1636
|
display_price: "$19.99"
|
|
@@ -1655,7 +1655,7 @@ paths:
|
|
|
1655
1655
|
digital_links: []
|
|
1656
1656
|
fulfillments:
|
|
1657
1657
|
- id: ful_gbHJdmfrXB
|
|
1658
|
-
number:
|
|
1658
|
+
number: H21805662439
|
|
1659
1659
|
tracking:
|
|
1660
1660
|
tracking_url:
|
|
1661
1661
|
cost: '10.0'
|
|
@@ -1684,7 +1684,7 @@ paths:
|
|
|
1684
1684
|
stock_location:
|
|
1685
1685
|
id: sloc_UkLWZg9DAJ
|
|
1686
1686
|
state_abbr: NY
|
|
1687
|
-
name:
|
|
1687
|
+
name: Inocencia Morissette
|
|
1688
1688
|
address1: 1600 Pennsylvania Ave NW
|
|
1689
1689
|
city: Washington
|
|
1690
1690
|
zipcode: '20500'
|
|
@@ -1716,7 +1716,7 @@ paths:
|
|
|
1716
1716
|
first_name: John
|
|
1717
1717
|
last_name: Doe
|
|
1718
1718
|
full_name: John Doe
|
|
1719
|
-
address1:
|
|
1719
|
+
address1: 117 Lovely Street
|
|
1720
1720
|
address2: Northwest
|
|
1721
1721
|
postal_code: '10118'
|
|
1722
1722
|
city: New York
|
|
@@ -1735,7 +1735,7 @@ paths:
|
|
|
1735
1735
|
first_name: John
|
|
1736
1736
|
last_name: Doe
|
|
1737
1737
|
full_name: John Doe
|
|
1738
|
-
address1:
|
|
1738
|
+
address1: 118 Lovely Street
|
|
1739
1739
|
address2: Northwest
|
|
1740
1740
|
postal_code: '10118'
|
|
1741
1741
|
city: New York
|
|
@@ -1844,7 +1844,7 @@ paths:
|
|
|
1844
1844
|
})
|
|
1845
1845
|
|
|
1846
1846
|
await client.carts.delete('cart_abc123', {
|
|
1847
|
-
|
|
1847
|
+
token: '<token>',
|
|
1848
1848
|
})
|
|
1849
1849
|
parameters:
|
|
1850
1850
|
- name: x-spree-api-key
|
|
@@ -1894,7 +1894,7 @@ paths:
|
|
|
1894
1894
|
})
|
|
1895
1895
|
|
|
1896
1896
|
const cart = await client.carts.associate('cart_abc123', {
|
|
1897
|
-
|
|
1897
|
+
token: '<token>',
|
|
1898
1898
|
})
|
|
1899
1899
|
parameters:
|
|
1900
1900
|
- name: x-spree-api-key
|
|
@@ -1921,9 +1921,9 @@ paths:
|
|
|
1921
1921
|
example:
|
|
1922
1922
|
id: cart_UkLWZg9DAJ
|
|
1923
1923
|
market_id:
|
|
1924
|
-
number:
|
|
1925
|
-
token:
|
|
1926
|
-
email:
|
|
1924
|
+
number: R087842008
|
|
1925
|
+
token: fk1roHKMAK2GbnicjHVZp2SZoDzSDUXZjz5
|
|
1926
|
+
email: rodrick.pfannerstill@bosco.name
|
|
1927
1927
|
customer_note:
|
|
1928
1928
|
currency: USD
|
|
1929
1929
|
locale: en
|
|
@@ -1965,8 +1965,8 @@ paths:
|
|
|
1965
1965
|
variant_id: variant_UkLWZg9DAJ
|
|
1966
1966
|
quantity: 1
|
|
1967
1967
|
currency: USD
|
|
1968
|
-
name: Product
|
|
1969
|
-
slug: product-
|
|
1968
|
+
name: Product 65297
|
|
1969
|
+
slug: product-65297
|
|
1970
1970
|
options_text: ''
|
|
1971
1971
|
price: '10.0'
|
|
1972
1972
|
display_price: "$10.00"
|
|
@@ -1991,7 +1991,7 @@ paths:
|
|
|
1991
1991
|
digital_links: []
|
|
1992
1992
|
fulfillments:
|
|
1993
1993
|
- id: ful_UkLWZg9DAJ
|
|
1994
|
-
number:
|
|
1994
|
+
number: H60628675689
|
|
1995
1995
|
tracking: U10000
|
|
1996
1996
|
tracking_url:
|
|
1997
1997
|
cost: '100.0'
|
|
@@ -2020,7 +2020,7 @@ paths:
|
|
|
2020
2020
|
stock_location:
|
|
2021
2021
|
id: sloc_UkLWZg9DAJ
|
|
2022
2022
|
state_abbr: NY
|
|
2023
|
-
name:
|
|
2023
|
+
name: Lucius Mueller
|
|
2024
2024
|
address1: 1600 Pennsylvania Ave NW
|
|
2025
2025
|
city: Washington
|
|
2026
2026
|
zipcode: '20500'
|
|
@@ -2052,7 +2052,7 @@ paths:
|
|
|
2052
2052
|
first_name: John
|
|
2053
2053
|
last_name: Doe
|
|
2054
2054
|
full_name: John Doe
|
|
2055
|
-
address1:
|
|
2055
|
+
address1: 123 Lovely Street
|
|
2056
2056
|
address2: Northwest
|
|
2057
2057
|
postal_code: '10118'
|
|
2058
2058
|
city: New York
|
|
@@ -2071,7 +2071,7 @@ paths:
|
|
|
2071
2071
|
first_name: John
|
|
2072
2072
|
last_name: Doe
|
|
2073
2073
|
full_name: John Doe
|
|
2074
|
-
address1:
|
|
2074
|
+
address1: 124 Lovely Street
|
|
2075
2075
|
address2: Northwest
|
|
2076
2076
|
postal_code: '10118'
|
|
2077
2077
|
city: New York
|
|
@@ -2122,7 +2122,7 @@ paths:
|
|
|
2122
2122
|
})
|
|
2123
2123
|
|
|
2124
2124
|
const order = await client.carts.complete('cart_abc123', {
|
|
2125
|
-
|
|
2125
|
+
token: '<token>',
|
|
2126
2126
|
})
|
|
2127
2127
|
parameters:
|
|
2128
2128
|
- name: x-spree-api-key
|
|
@@ -2154,8 +2154,9 @@ paths:
|
|
|
2154
2154
|
example:
|
|
2155
2155
|
id: or_UkLWZg9DAJ
|
|
2156
2156
|
market_id:
|
|
2157
|
-
|
|
2158
|
-
|
|
2157
|
+
channel_id: ch_UkLWZg9DAJ
|
|
2158
|
+
number: R214914408
|
|
2159
|
+
email: raeann_heidenreich@rau.ca
|
|
2159
2160
|
customer_note:
|
|
2160
2161
|
currency: USD
|
|
2161
2162
|
locale: en
|
|
@@ -2182,7 +2183,7 @@ paths:
|
|
|
2182
2183
|
display_delivery_total: "$10.00"
|
|
2183
2184
|
fulfillment_status: backorder
|
|
2184
2185
|
payment_status: paid
|
|
2185
|
-
completed_at: '2026-05-
|
|
2186
|
+
completed_at: '2026-05-12T17:42:48.371Z'
|
|
2186
2187
|
store_credit_total: '0.0'
|
|
2187
2188
|
display_store_credit_total: "$0.00"
|
|
2188
2189
|
covered_by_store_credit: false
|
|
@@ -2192,8 +2193,8 @@ paths:
|
|
|
2192
2193
|
variant_id: variant_UkLWZg9DAJ
|
|
2193
2194
|
quantity: 1
|
|
2194
2195
|
currency: USD
|
|
2195
|
-
name: Product
|
|
2196
|
-
slug: product-
|
|
2196
|
+
name: Product 671016
|
|
2197
|
+
slug: product-671016
|
|
2197
2198
|
options_text: ''
|
|
2198
2199
|
price: '19.99'
|
|
2199
2200
|
display_price: "$19.99"
|
|
@@ -2218,7 +2219,7 @@ paths:
|
|
|
2218
2219
|
digital_links: []
|
|
2219
2220
|
fulfillments:
|
|
2220
2221
|
- id: ful_gbHJdmfrXB
|
|
2221
|
-
number:
|
|
2222
|
+
number: H06973932605
|
|
2222
2223
|
tracking:
|
|
2223
2224
|
tracking_url:
|
|
2224
2225
|
cost: '10.0'
|
|
@@ -2247,7 +2248,7 @@ paths:
|
|
|
2247
2248
|
stock_location:
|
|
2248
2249
|
id: sloc_UkLWZg9DAJ
|
|
2249
2250
|
state_abbr: NY
|
|
2250
|
-
name:
|
|
2251
|
+
name: Tom Blick
|
|
2251
2252
|
address1: 1600 Pennsylvania Ave NW
|
|
2252
2253
|
city: Washington
|
|
2253
2254
|
zipcode: '20500'
|
|
@@ -2276,8 +2277,8 @@ paths:
|
|
|
2276
2277
|
payments:
|
|
2277
2278
|
- id: py_UkLWZg9DAJ
|
|
2278
2279
|
payment_method_id: pm_UkLWZg9DAJ
|
|
2279
|
-
response_code: BGS-
|
|
2280
|
-
number:
|
|
2280
|
+
response_code: BGS-a6b953882c80
|
|
2281
|
+
number: PKYQQTAC
|
|
2281
2282
|
amount: '29.99'
|
|
2282
2283
|
display_amount: "$29.99"
|
|
2283
2284
|
status: completed
|
|
@@ -2296,7 +2297,7 @@ paths:
|
|
|
2296
2297
|
id: pm_UkLWZg9DAJ
|
|
2297
2298
|
name: Check
|
|
2298
2299
|
description:
|
|
2299
|
-
type:
|
|
2300
|
+
type: check
|
|
2300
2301
|
session_required: false
|
|
2301
2302
|
source_required: false
|
|
2302
2303
|
billing_address:
|
|
@@ -2304,7 +2305,7 @@ paths:
|
|
|
2304
2305
|
first_name: John
|
|
2305
2306
|
last_name: Doe
|
|
2306
2307
|
full_name: John Doe
|
|
2307
|
-
address1:
|
|
2308
|
+
address1: 131 Lovely Street
|
|
2308
2309
|
address2: Northwest
|
|
2309
2310
|
postal_code: '10118'
|
|
2310
2311
|
city: New York
|
|
@@ -2323,7 +2324,7 @@ paths:
|
|
|
2323
2324
|
first_name: John
|
|
2324
2325
|
last_name: Doe
|
|
2325
2326
|
full_name: John Doe
|
|
2326
|
-
address1:
|
|
2327
|
+
address1: 132 Lovely Street
|
|
2327
2328
|
address2: Northwest
|
|
2328
2329
|
postal_code: '10118'
|
|
2329
2330
|
city: New York
|
|
@@ -2510,7 +2511,7 @@ paths:
|
|
|
2510
2511
|
})
|
|
2511
2512
|
|
|
2512
2513
|
const category = await client.categories.get('categories/clothing/shirts', {
|
|
2513
|
-
expand: 'children',
|
|
2514
|
+
expand: ['children'],
|
|
2514
2515
|
})
|
|
2515
2516
|
parameters:
|
|
2516
2517
|
- name: x-spree-api-key
|
|
@@ -2625,7 +2626,7 @@ paths:
|
|
|
2625
2626
|
example:
|
|
2626
2627
|
data:
|
|
2627
2628
|
- iso: DE
|
|
2628
|
-
iso3:
|
|
2629
|
+
iso3: IS39
|
|
2629
2630
|
name: Germany
|
|
2630
2631
|
states_required: false
|
|
2631
2632
|
zipcode_required: true
|
|
@@ -2754,7 +2755,7 @@ paths:
|
|
|
2754
2755
|
})
|
|
2755
2756
|
|
|
2756
2757
|
const cards = await client.customer.creditCards.list({}, {
|
|
2757
|
-
|
|
2758
|
+
token: '<token>',
|
|
2758
2759
|
})
|
|
2759
2760
|
parameters:
|
|
2760
2761
|
- name: x-spree-api-key
|
|
@@ -2849,7 +2850,7 @@ paths:
|
|
|
2849
2850
|
})
|
|
2850
2851
|
|
|
2851
2852
|
const card = await client.customer.creditCards.get('card_abc123', {
|
|
2852
|
-
|
|
2853
|
+
token: '<token>',
|
|
2853
2854
|
})
|
|
2854
2855
|
parameters:
|
|
2855
2856
|
- name: x-spree-api-key
|
|
@@ -2920,7 +2921,7 @@ paths:
|
|
|
2920
2921
|
})
|
|
2921
2922
|
|
|
2922
2923
|
await client.customer.creditCards.delete('card_abc123', {
|
|
2923
|
-
|
|
2924
|
+
token: '<token>',
|
|
2924
2925
|
})
|
|
2925
2926
|
parameters:
|
|
2926
2927
|
- name: x-spree-api-key
|
|
@@ -3133,16 +3134,16 @@ paths:
|
|
|
3133
3134
|
content:
|
|
3134
3135
|
application/json:
|
|
3135
3136
|
example:
|
|
3136
|
-
token: eyJhbGciOiJIUzI1NiJ9.
|
|
3137
|
-
refresh_token:
|
|
3137
|
+
token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImQ1MzJkZjZiLTMzMTEtNGQ4Ny05MDYxLWZmMWFkY2IzNDI0MSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc4NjExMzc1fQ.Nv6Br1Or3P_q74hrZllyKrdgJCjOrn3iOQMhY5suKSc
|
|
3138
|
+
refresh_token: pnwsvmHz4M9Co1Vnu5jPsBoT
|
|
3138
3139
|
user:
|
|
3139
3140
|
id: cus_UkLWZg9DAJ
|
|
3140
3141
|
email: customer@example.com
|
|
3141
|
-
first_name:
|
|
3142
|
-
last_name:
|
|
3142
|
+
first_name: Jed
|
|
3143
|
+
last_name: Koss
|
|
3143
3144
|
phone:
|
|
3144
3145
|
accepts_email_marketing: false
|
|
3145
|
-
full_name:
|
|
3146
|
+
full_name: Jed Koss
|
|
3146
3147
|
available_store_credit_total: '0'
|
|
3147
3148
|
display_available_store_credit_total: "$0.00"
|
|
3148
3149
|
addresses: []
|
|
@@ -3210,11 +3211,13 @@ paths:
|
|
|
3210
3211
|
publishableKey: '<api-key>',
|
|
3211
3212
|
})
|
|
3212
3213
|
|
|
3213
|
-
const orders = await client.customer.orders.list(
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3214
|
+
const orders = await client.customer.orders.list(
|
|
3215
|
+
{
|
|
3216
|
+
completed_at_gt: '2026-01-01',
|
|
3217
|
+
sort: '-completed_at',
|
|
3218
|
+
},
|
|
3219
|
+
{ token: '<token>' },
|
|
3220
|
+
)
|
|
3218
3221
|
parameters:
|
|
3219
3222
|
- name: x-spree-api-key
|
|
3220
3223
|
in: header
|
|
@@ -3312,8 +3315,9 @@ paths:
|
|
|
3312
3315
|
data:
|
|
3313
3316
|
- id: or_UkLWZg9DAJ
|
|
3314
3317
|
market_id:
|
|
3315
|
-
|
|
3316
|
-
|
|
3318
|
+
channel_id: ch_UkLWZg9DAJ
|
|
3319
|
+
number: R841044915
|
|
3320
|
+
email: arlyne.bergstrom@kemmer.info
|
|
3317
3321
|
customer_note:
|
|
3318
3322
|
currency: USD
|
|
3319
3323
|
locale: en
|
|
@@ -3340,7 +3344,7 @@ paths:
|
|
|
3340
3344
|
display_delivery_total: "$100.00"
|
|
3341
3345
|
fulfillment_status:
|
|
3342
3346
|
payment_status:
|
|
3343
|
-
completed_at: '2026-05-
|
|
3347
|
+
completed_at: '2026-05-12T17:42:55.946Z'
|
|
3344
3348
|
store_credit_total: '0.0'
|
|
3345
3349
|
display_store_credit_total: "$0.00"
|
|
3346
3350
|
covered_by_store_credit: false
|
|
@@ -3350,8 +3354,8 @@ paths:
|
|
|
3350
3354
|
variant_id: variant_UkLWZg9DAJ
|
|
3351
3355
|
quantity: 1
|
|
3352
3356
|
currency: USD
|
|
3353
|
-
name: Product
|
|
3354
|
-
slug: product-
|
|
3357
|
+
name: Product 766867
|
|
3358
|
+
slug: product-766867
|
|
3355
3359
|
options_text: ''
|
|
3356
3360
|
price: '10.0'
|
|
3357
3361
|
display_price: "$10.00"
|
|
@@ -3376,7 +3380,7 @@ paths:
|
|
|
3376
3380
|
digital_links: []
|
|
3377
3381
|
fulfillments:
|
|
3378
3382
|
- id: ful_UkLWZg9DAJ
|
|
3379
|
-
number:
|
|
3383
|
+
number: H50242331103
|
|
3380
3384
|
tracking: U10000
|
|
3381
3385
|
tracking_url:
|
|
3382
3386
|
cost: '100.0'
|
|
@@ -3405,7 +3409,7 @@ paths:
|
|
|
3405
3409
|
stock_location:
|
|
3406
3410
|
id: sloc_UkLWZg9DAJ
|
|
3407
3411
|
state_abbr: NY
|
|
3408
|
-
name:
|
|
3412
|
+
name: Hipolito Zulauf
|
|
3409
3413
|
address1: 1600 Pennsylvania Ave NW
|
|
3410
3414
|
city: Washington
|
|
3411
3415
|
zipcode: '20500'
|
|
@@ -3437,7 +3441,7 @@ paths:
|
|
|
3437
3441
|
first_name: John
|
|
3438
3442
|
last_name: Doe
|
|
3439
3443
|
full_name: John Doe
|
|
3440
|
-
address1:
|
|
3444
|
+
address1: 151 Lovely Street
|
|
3441
3445
|
address2: Northwest
|
|
3442
3446
|
postal_code: '10118'
|
|
3443
3447
|
city: New York
|
|
@@ -3456,7 +3460,7 @@ paths:
|
|
|
3456
3460
|
first_name: John
|
|
3457
3461
|
last_name: Doe
|
|
3458
3462
|
full_name: John Doe
|
|
3459
|
-
address1:
|
|
3463
|
+
address1: 152 Lovely Street
|
|
3460
3464
|
address2: Northwest
|
|
3461
3465
|
postal_code: '10118'
|
|
3462
3466
|
city: New York
|
|
@@ -3524,8 +3528,8 @@ paths:
|
|
|
3524
3528
|
publishableKey: '<api-key>',
|
|
3525
3529
|
})
|
|
3526
3530
|
|
|
3527
|
-
const order = await client.customer.orders.get('or_abc123', {
|
|
3528
|
-
|
|
3531
|
+
const order = await client.customer.orders.get('or_abc123', {}, {
|
|
3532
|
+
token: '<token>',
|
|
3529
3533
|
})
|
|
3530
3534
|
parameters:
|
|
3531
3535
|
- name: x-spree-api-key
|
|
@@ -3567,8 +3571,9 @@ paths:
|
|
|
3567
3571
|
example:
|
|
3568
3572
|
id: or_UkLWZg9DAJ
|
|
3569
3573
|
market_id:
|
|
3570
|
-
|
|
3571
|
-
|
|
3574
|
+
channel_id: ch_UkLWZg9DAJ
|
|
3575
|
+
number: R672980739
|
|
3576
|
+
email: efren@mosciski.us
|
|
3572
3577
|
customer_note:
|
|
3573
3578
|
currency: USD
|
|
3574
3579
|
locale: en
|
|
@@ -3595,7 +3600,7 @@ paths:
|
|
|
3595
3600
|
display_delivery_total: "$100.00"
|
|
3596
3601
|
fulfillment_status:
|
|
3597
3602
|
payment_status:
|
|
3598
|
-
completed_at: '2026-05-
|
|
3603
|
+
completed_at: '2026-05-12T17:42:56.639Z'
|
|
3599
3604
|
store_credit_total: '0.0'
|
|
3600
3605
|
display_store_credit_total: "$0.00"
|
|
3601
3606
|
covered_by_store_credit: false
|
|
@@ -3605,8 +3610,8 @@ paths:
|
|
|
3605
3610
|
variant_id: variant_UkLWZg9DAJ
|
|
3606
3611
|
quantity: 1
|
|
3607
3612
|
currency: USD
|
|
3608
|
-
name: Product
|
|
3609
|
-
slug: product-
|
|
3613
|
+
name: Product 784570
|
|
3614
|
+
slug: product-784570
|
|
3610
3615
|
options_text: ''
|
|
3611
3616
|
price: '10.0'
|
|
3612
3617
|
display_price: "$10.00"
|
|
@@ -3631,7 +3636,7 @@ paths:
|
|
|
3631
3636
|
digital_links: []
|
|
3632
3637
|
fulfillments:
|
|
3633
3638
|
- id: ful_UkLWZg9DAJ
|
|
3634
|
-
number:
|
|
3639
|
+
number: H11212800023
|
|
3635
3640
|
tracking: U10000
|
|
3636
3641
|
tracking_url:
|
|
3637
3642
|
cost: '100.0'
|
|
@@ -3660,7 +3665,7 @@ paths:
|
|
|
3660
3665
|
stock_location:
|
|
3661
3666
|
id: sloc_UkLWZg9DAJ
|
|
3662
3667
|
state_abbr: NY
|
|
3663
|
-
name:
|
|
3668
|
+
name: Nieves Wolff
|
|
3664
3669
|
address1: 1600 Pennsylvania Ave NW
|
|
3665
3670
|
city: Washington
|
|
3666
3671
|
zipcode: '20500'
|
|
@@ -3692,7 +3697,7 @@ paths:
|
|
|
3692
3697
|
first_name: John
|
|
3693
3698
|
last_name: Doe
|
|
3694
3699
|
full_name: John Doe
|
|
3695
|
-
address1:
|
|
3700
|
+
address1: 157 Lovely Street
|
|
3696
3701
|
address2: Northwest
|
|
3697
3702
|
postal_code: '10118'
|
|
3698
3703
|
city: New York
|
|
@@ -3711,7 +3716,7 @@ paths:
|
|
|
3711
3716
|
first_name: John
|
|
3712
3717
|
last_name: Doe
|
|
3713
3718
|
full_name: John Doe
|
|
3714
|
-
address1:
|
|
3719
|
+
address1: 158 Lovely Street
|
|
3715
3720
|
address2: Northwest
|
|
3716
3721
|
postal_code: '10118'
|
|
3717
3722
|
city: New York
|
|
@@ -3780,8 +3785,8 @@ paths:
|
|
|
3780
3785
|
content:
|
|
3781
3786
|
application/json:
|
|
3782
3787
|
example:
|
|
3783
|
-
token: eyJhbGciOiJIUzI1NiJ9.
|
|
3784
|
-
refresh_token:
|
|
3788
|
+
token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImJjYzczNzNjLTkwMzktNDNkZC1iYTI2LTllNGNhMGM2MWI3NiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc4NjExMzc3fQ.rouqbc-73cM4ejG_BfAXKDiT2QKKTCd6MBFuvwFtyes
|
|
3789
|
+
refresh_token: Qz7Ckpmeo2YGTeFCJsf6pvbj
|
|
3785
3790
|
user:
|
|
3786
3791
|
id: cus_UkLWZg9DAJ
|
|
3787
3792
|
email: newuser@example.com
|
|
@@ -3867,7 +3872,7 @@ paths:
|
|
|
3867
3872
|
})
|
|
3868
3873
|
|
|
3869
3874
|
const customer = await client.customer.get({
|
|
3870
|
-
|
|
3875
|
+
token: '<token>',
|
|
3871
3876
|
})
|
|
3872
3877
|
parameters:
|
|
3873
3878
|
- name: x-spree-api-key
|
|
@@ -3895,12 +3900,12 @@ paths:
|
|
|
3895
3900
|
application/json:
|
|
3896
3901
|
example:
|
|
3897
3902
|
id: cus_UkLWZg9DAJ
|
|
3898
|
-
email:
|
|
3899
|
-
first_name:
|
|
3900
|
-
last_name:
|
|
3903
|
+
email: carolee@lynchconn.com
|
|
3904
|
+
first_name: Jessia
|
|
3905
|
+
last_name: Mayert
|
|
3901
3906
|
phone: 555-555-0199
|
|
3902
3907
|
accepts_email_marketing: false
|
|
3903
|
-
full_name:
|
|
3908
|
+
full_name: Jessia Mayert
|
|
3904
3909
|
available_store_credit_total: '0'
|
|
3905
3910
|
display_available_store_credit_total: "$0.00"
|
|
3906
3911
|
addresses:
|
|
@@ -3908,7 +3913,7 @@ paths:
|
|
|
3908
3913
|
first_name: John
|
|
3909
3914
|
last_name: Doe
|
|
3910
3915
|
full_name: John Doe
|
|
3911
|
-
address1:
|
|
3916
|
+
address1: 164 Lovely Street
|
|
3912
3917
|
address2: Northwest
|
|
3913
3918
|
postal_code: '10118'
|
|
3914
3919
|
city: New York
|
|
@@ -3926,7 +3931,7 @@ paths:
|
|
|
3926
3931
|
first_name: John
|
|
3927
3932
|
last_name: Doe
|
|
3928
3933
|
full_name: John Doe
|
|
3929
|
-
address1:
|
|
3934
|
+
address1: 163 Lovely Street
|
|
3930
3935
|
address2: Northwest
|
|
3931
3936
|
postal_code: '10118'
|
|
3932
3937
|
city: New York
|
|
@@ -3945,7 +3950,7 @@ paths:
|
|
|
3945
3950
|
first_name: John
|
|
3946
3951
|
last_name: Doe
|
|
3947
3952
|
full_name: John Doe
|
|
3948
|
-
address1:
|
|
3953
|
+
address1: 164 Lovely Street
|
|
3949
3954
|
address2: Northwest
|
|
3950
3955
|
postal_code: '10118'
|
|
3951
3956
|
city: New York
|
|
@@ -3964,7 +3969,7 @@ paths:
|
|
|
3964
3969
|
first_name: John
|
|
3965
3970
|
last_name: Doe
|
|
3966
3971
|
full_name: John Doe
|
|
3967
|
-
address1:
|
|
3972
|
+
address1: 163 Lovely Street
|
|
3968
3973
|
address2: Northwest
|
|
3969
3974
|
postal_code: '10118'
|
|
3970
3975
|
city: New York
|
|
@@ -4014,7 +4019,7 @@ paths:
|
|
|
4014
4019
|
last_name: 'Doe',
|
|
4015
4020
|
metadata: { preferred_contact: 'email' },
|
|
4016
4021
|
}, {
|
|
4017
|
-
|
|
4022
|
+
token: '<token>',
|
|
4018
4023
|
})
|
|
4019
4024
|
parameters:
|
|
4020
4025
|
- name: x-spree-api-key
|
|
@@ -4034,7 +4039,7 @@ paths:
|
|
|
4034
4039
|
application/json:
|
|
4035
4040
|
example:
|
|
4036
4041
|
id: cus_UkLWZg9DAJ
|
|
4037
|
-
email:
|
|
4042
|
+
email: emilee.predovic@aufderharbarrows.us
|
|
4038
4043
|
first_name: Updated
|
|
4039
4044
|
last_name: Name
|
|
4040
4045
|
phone: 555-555-0199
|
|
@@ -4047,7 +4052,7 @@ paths:
|
|
|
4047
4052
|
first_name: John
|
|
4048
4053
|
last_name: Doe
|
|
4049
4054
|
full_name: John Doe
|
|
4050
|
-
address1:
|
|
4055
|
+
address1: 166 Lovely Street
|
|
4051
4056
|
address2: Northwest
|
|
4052
4057
|
postal_code: '10118'
|
|
4053
4058
|
city: New York
|
|
@@ -4065,7 +4070,7 @@ paths:
|
|
|
4065
4070
|
first_name: John
|
|
4066
4071
|
last_name: Doe
|
|
4067
4072
|
full_name: John Doe
|
|
4068
|
-
address1:
|
|
4073
|
+
address1: 165 Lovely Street
|
|
4069
4074
|
address2: Northwest
|
|
4070
4075
|
postal_code: '10118'
|
|
4071
4076
|
city: New York
|
|
@@ -4084,7 +4089,7 @@ paths:
|
|
|
4084
4089
|
first_name: John
|
|
4085
4090
|
last_name: Doe
|
|
4086
4091
|
full_name: John Doe
|
|
4087
|
-
address1:
|
|
4092
|
+
address1: 166 Lovely Street
|
|
4088
4093
|
address2: Northwest
|
|
4089
4094
|
postal_code: '10118'
|
|
4090
4095
|
city: New York
|
|
@@ -4103,7 +4108,7 @@ paths:
|
|
|
4103
4108
|
first_name: John
|
|
4104
4109
|
last_name: Doe
|
|
4105
4110
|
full_name: John Doe
|
|
4106
|
-
address1:
|
|
4111
|
+
address1: 165 Lovely Street
|
|
4107
4112
|
address2: Northwest
|
|
4108
4113
|
postal_code: '10118'
|
|
4109
4114
|
city: New York
|
|
@@ -4234,7 +4239,7 @@ paths:
|
|
|
4234
4239
|
})
|
|
4235
4240
|
|
|
4236
4241
|
const cart = await client.carts.discountCodes.apply('cart_abc123', 'SAVE10', {
|
|
4237
|
-
|
|
4242
|
+
token: '<token>',
|
|
4238
4243
|
})
|
|
4239
4244
|
parameters:
|
|
4240
4245
|
- name: x-spree-api-key
|
|
@@ -4274,9 +4279,9 @@ paths:
|
|
|
4274
4279
|
example:
|
|
4275
4280
|
id: cart_UkLWZg9DAJ
|
|
4276
4281
|
market_id:
|
|
4277
|
-
number:
|
|
4278
|
-
token:
|
|
4279
|
-
email:
|
|
4282
|
+
number: R746600783
|
|
4283
|
+
token: Kt9NRNj9Y1Rr7VW4YYNfsm2BgMkVBCu2QLV
|
|
4284
|
+
email: charlesetta@ferrykreiger.info
|
|
4280
4285
|
customer_note:
|
|
4281
4286
|
currency: USD
|
|
4282
4287
|
locale: en
|
|
@@ -4325,8 +4330,8 @@ paths:
|
|
|
4325
4330
|
variant_id: variant_UkLWZg9DAJ
|
|
4326
4331
|
quantity: 1
|
|
4327
4332
|
currency: USD
|
|
4328
|
-
name: Product
|
|
4329
|
-
slug: product-
|
|
4333
|
+
name: Product 863751
|
|
4334
|
+
slug: product-863751
|
|
4330
4335
|
options_text: ''
|
|
4331
4336
|
price: '10.0'
|
|
4332
4337
|
display_price: "$10.00"
|
|
@@ -4351,7 +4356,7 @@ paths:
|
|
|
4351
4356
|
digital_links: []
|
|
4352
4357
|
fulfillments:
|
|
4353
4358
|
- id: ful_UkLWZg9DAJ
|
|
4354
|
-
number:
|
|
4359
|
+
number: H46654349123
|
|
4355
4360
|
tracking: U10000
|
|
4356
4361
|
tracking_url:
|
|
4357
4362
|
cost: '100.0'
|
|
@@ -4380,7 +4385,7 @@ paths:
|
|
|
4380
4385
|
stock_location:
|
|
4381
4386
|
id: sloc_UkLWZg9DAJ
|
|
4382
4387
|
state_abbr: NY
|
|
4383
|
-
name:
|
|
4388
|
+
name: Araceli Langworth
|
|
4384
4389
|
address1: 1600 Pennsylvania Ave NW
|
|
4385
4390
|
city: Washington
|
|
4386
4391
|
zipcode: '20500'
|
|
@@ -4412,7 +4417,7 @@ paths:
|
|
|
4412
4417
|
first_name: John
|
|
4413
4418
|
last_name: Doe
|
|
4414
4419
|
full_name: John Doe
|
|
4415
|
-
address1:
|
|
4420
|
+
address1: 183 Lovely Street
|
|
4416
4421
|
address2: Northwest
|
|
4417
4422
|
postal_code: '10118'
|
|
4418
4423
|
city: New York
|
|
@@ -4431,7 +4436,7 @@ paths:
|
|
|
4431
4436
|
first_name: John
|
|
4432
4437
|
last_name: Doe
|
|
4433
4438
|
full_name: John Doe
|
|
4434
|
-
address1:
|
|
4439
|
+
address1: 184 Lovely Street
|
|
4435
4440
|
address2: Northwest
|
|
4436
4441
|
postal_code: '10118'
|
|
4437
4442
|
city: New York
|
|
@@ -4494,7 +4499,7 @@ paths:
|
|
|
4494
4499
|
})
|
|
4495
4500
|
|
|
4496
4501
|
const cart = await client.carts.discountCodes.remove('cart_abc123', 'SAVE10', {
|
|
4497
|
-
|
|
4502
|
+
token: '<token>',
|
|
4498
4503
|
})
|
|
4499
4504
|
parameters:
|
|
4500
4505
|
- name: x-spree-api-key
|
|
@@ -4534,9 +4539,9 @@ paths:
|
|
|
4534
4539
|
example:
|
|
4535
4540
|
id: cart_UkLWZg9DAJ
|
|
4536
4541
|
market_id:
|
|
4537
|
-
number:
|
|
4538
|
-
token:
|
|
4539
|
-
email:
|
|
4542
|
+
number: R915420779
|
|
4543
|
+
token: KWwBiKXi9AThQF4mTKENbtLV88vfMeqBg89
|
|
4544
|
+
email: phebe_yundt@nienow.com
|
|
4540
4545
|
customer_note:
|
|
4541
4546
|
currency: USD
|
|
4542
4547
|
locale: en
|
|
@@ -4578,8 +4583,8 @@ paths:
|
|
|
4578
4583
|
variant_id: variant_UkLWZg9DAJ
|
|
4579
4584
|
quantity: 1
|
|
4580
4585
|
currency: USD
|
|
4581
|
-
name: Product
|
|
4582
|
-
slug: product-
|
|
4586
|
+
name: Product 886079
|
|
4587
|
+
slug: product-886079
|
|
4583
4588
|
options_text: ''
|
|
4584
4589
|
price: '10.0'
|
|
4585
4590
|
display_price: "$10.00"
|
|
@@ -4604,7 +4609,7 @@ paths:
|
|
|
4604
4609
|
digital_links: []
|
|
4605
4610
|
fulfillments:
|
|
4606
4611
|
- id: ful_UkLWZg9DAJ
|
|
4607
|
-
number:
|
|
4612
|
+
number: H22719155222
|
|
4608
4613
|
tracking: U10000
|
|
4609
4614
|
tracking_url:
|
|
4610
4615
|
cost: '100.0'
|
|
@@ -4633,7 +4638,7 @@ paths:
|
|
|
4633
4638
|
stock_location:
|
|
4634
4639
|
id: sloc_UkLWZg9DAJ
|
|
4635
4640
|
state_abbr: NY
|
|
4636
|
-
name:
|
|
4641
|
+
name: Leeanne Gulgowski
|
|
4637
4642
|
address1: 1600 Pennsylvania Ave NW
|
|
4638
4643
|
city: Washington
|
|
4639
4644
|
zipcode: '20500'
|
|
@@ -4665,7 +4670,7 @@ paths:
|
|
|
4665
4670
|
first_name: John
|
|
4666
4671
|
last_name: Doe
|
|
4667
4672
|
full_name: John Doe
|
|
4668
|
-
address1:
|
|
4673
|
+
address1: 191 Lovely Street
|
|
4669
4674
|
address2: Northwest
|
|
4670
4675
|
postal_code: '10118'
|
|
4671
4676
|
city: New York
|
|
@@ -4684,7 +4689,7 @@ paths:
|
|
|
4684
4689
|
first_name: John
|
|
4685
4690
|
last_name: Doe
|
|
4686
4691
|
full_name: John Doe
|
|
4687
|
-
address1:
|
|
4692
|
+
address1: 192 Lovely Street
|
|
4688
4693
|
address2: Northwest
|
|
4689
4694
|
postal_code: '10118'
|
|
4690
4695
|
city: New York
|
|
@@ -4737,7 +4742,7 @@ paths:
|
|
|
4737
4742
|
const cart = await client.carts.fulfillments.update('cart_abc123', 'ful_abc123', {
|
|
4738
4743
|
selected_delivery_rate_id: 'dr_abc123',
|
|
4739
4744
|
}, {
|
|
4740
|
-
|
|
4745
|
+
token: '<token>',
|
|
4741
4746
|
})
|
|
4742
4747
|
parameters:
|
|
4743
4748
|
- name: x-spree-api-key
|
|
@@ -4776,9 +4781,9 @@ paths:
|
|
|
4776
4781
|
example:
|
|
4777
4782
|
id: cart_UkLWZg9DAJ
|
|
4778
4783
|
market_id:
|
|
4779
|
-
number:
|
|
4780
|
-
token:
|
|
4781
|
-
email:
|
|
4784
|
+
number: R881626278
|
|
4785
|
+
token: x6aARFGsiULvJ4yhvavyWPC6AGYTdQfRDFn
|
|
4786
|
+
email: cristal@kozey.name
|
|
4782
4787
|
customer_note:
|
|
4783
4788
|
currency: USD
|
|
4784
4789
|
locale: en
|
|
@@ -4822,8 +4827,8 @@ paths:
|
|
|
4822
4827
|
variant_id: variant_UkLWZg9DAJ
|
|
4823
4828
|
quantity: 1
|
|
4824
4829
|
currency: USD
|
|
4825
|
-
name: Product
|
|
4826
|
-
slug: product-
|
|
4830
|
+
name: Product 906417
|
|
4831
|
+
slug: product-906417
|
|
4827
4832
|
options_text: ''
|
|
4828
4833
|
price: '10.0'
|
|
4829
4834
|
display_price: "$10.00"
|
|
@@ -4848,7 +4853,7 @@ paths:
|
|
|
4848
4853
|
digital_links: []
|
|
4849
4854
|
fulfillments:
|
|
4850
4855
|
- id: ful_UkLWZg9DAJ
|
|
4851
|
-
number:
|
|
4856
|
+
number: H16578499128
|
|
4852
4857
|
tracking: U10000
|
|
4853
4858
|
tracking_url:
|
|
4854
4859
|
cost: '100.0'
|
|
@@ -4877,7 +4882,7 @@ paths:
|
|
|
4877
4882
|
stock_location:
|
|
4878
4883
|
id: sloc_UkLWZg9DAJ
|
|
4879
4884
|
state_abbr: NY
|
|
4880
|
-
name:
|
|
4885
|
+
name: Samual Swaniawski
|
|
4881
4886
|
address1: 1600 Pennsylvania Ave NW
|
|
4882
4887
|
city: Washington
|
|
4883
4888
|
zipcode: '20500'
|
|
@@ -4909,7 +4914,7 @@ paths:
|
|
|
4909
4914
|
first_name: John
|
|
4910
4915
|
last_name: Doe
|
|
4911
4916
|
full_name: John Doe
|
|
4912
|
-
address1:
|
|
4917
|
+
address1: 199 Lovely Street
|
|
4913
4918
|
address2: Northwest
|
|
4914
4919
|
postal_code: '10118'
|
|
4915
4920
|
city: New York
|
|
@@ -4928,7 +4933,7 @@ paths:
|
|
|
4928
4933
|
first_name: John
|
|
4929
4934
|
last_name: Doe
|
|
4930
4935
|
full_name: John Doe
|
|
4931
|
-
address1:
|
|
4936
|
+
address1: 200 Lovely Street
|
|
4932
4937
|
address2: Northwest
|
|
4933
4938
|
postal_code: '10118'
|
|
4934
4939
|
city: New York
|
|
@@ -4994,7 +4999,7 @@ paths:
|
|
|
4994
4999
|
})
|
|
4995
5000
|
|
|
4996
5001
|
const cart = await client.carts.giftCards.apply('cart_abc123', 'GC-ABCD-1234', {
|
|
4997
|
-
|
|
5002
|
+
token: '<token>',
|
|
4998
5003
|
})
|
|
4999
5004
|
parameters:
|
|
5000
5005
|
- name: x-spree-api-key
|
|
@@ -5034,9 +5039,9 @@ paths:
|
|
|
5034
5039
|
example:
|
|
5035
5040
|
id: cart_UkLWZg9DAJ
|
|
5036
5041
|
market_id:
|
|
5037
|
-
number:
|
|
5038
|
-
token:
|
|
5039
|
-
email:
|
|
5042
|
+
number: R378191151
|
|
5043
|
+
token: EmcQHBNj4YHQz8sLgG5DfxL9CD1RqMd29fn
|
|
5044
|
+
email: elouise@okeefe.biz
|
|
5040
5045
|
customer_note:
|
|
5041
5046
|
currency: USD
|
|
5042
5047
|
locale: en
|
|
@@ -5075,8 +5080,8 @@ paths:
|
|
|
5075
5080
|
variant_id: variant_UkLWZg9DAJ
|
|
5076
5081
|
quantity: 1
|
|
5077
5082
|
currency: USD
|
|
5078
|
-
name: Product
|
|
5079
|
-
slug: product-
|
|
5083
|
+
name: Product 921863
|
|
5084
|
+
slug: product-921863
|
|
5080
5085
|
options_text: ''
|
|
5081
5086
|
price: '10.0'
|
|
5082
5087
|
display_price: "$10.00"
|
|
@@ -5101,7 +5106,7 @@ paths:
|
|
|
5101
5106
|
digital_links: []
|
|
5102
5107
|
fulfillments:
|
|
5103
5108
|
- id: ful_UkLWZg9DAJ
|
|
5104
|
-
number:
|
|
5109
|
+
number: H19790946099
|
|
5105
5110
|
tracking: U10000
|
|
5106
5111
|
tracking_url:
|
|
5107
5112
|
cost: '100.0'
|
|
@@ -5130,7 +5135,7 @@ paths:
|
|
|
5130
5135
|
stock_location:
|
|
5131
5136
|
id: sloc_UkLWZg9DAJ
|
|
5132
5137
|
state_abbr: NY
|
|
5133
|
-
name:
|
|
5138
|
+
name: September Stoltenberg
|
|
5134
5139
|
address1: 1600 Pennsylvania Ave NW
|
|
5135
5140
|
city: Washington
|
|
5136
5141
|
zipcode: '20500'
|
|
@@ -5159,8 +5164,8 @@ paths:
|
|
|
5159
5164
|
payments:
|
|
5160
5165
|
- id: py_UkLWZg9DAJ
|
|
5161
5166
|
payment_method_id: pm_UkLWZg9DAJ
|
|
5162
|
-
response_code: 1-SC-
|
|
5163
|
-
number:
|
|
5167
|
+
response_code: 1-SC-20260512174306489093
|
|
5168
|
+
number: PTYHCXTI
|
|
5164
5169
|
amount: '50.0'
|
|
5165
5170
|
display_amount: "$50.00"
|
|
5166
5171
|
status: checkout
|
|
@@ -5179,7 +5184,7 @@ paths:
|
|
|
5179
5184
|
id: pm_UkLWZg9DAJ
|
|
5180
5185
|
name: Store Credit
|
|
5181
5186
|
description:
|
|
5182
|
-
type:
|
|
5187
|
+
type: store_credit
|
|
5183
5188
|
session_required: false
|
|
5184
5189
|
source_required: true
|
|
5185
5190
|
billing_address:
|
|
@@ -5187,7 +5192,7 @@ paths:
|
|
|
5187
5192
|
first_name: John
|
|
5188
5193
|
last_name: Doe
|
|
5189
5194
|
full_name: John Doe
|
|
5190
|
-
address1:
|
|
5195
|
+
address1: 207 Lovely Street
|
|
5191
5196
|
address2: Northwest
|
|
5192
5197
|
postal_code: '10118'
|
|
5193
5198
|
city: New York
|
|
@@ -5206,7 +5211,7 @@ paths:
|
|
|
5206
5211
|
first_name: John
|
|
5207
5212
|
last_name: Doe
|
|
5208
5213
|
full_name: John Doe
|
|
5209
|
-
address1:
|
|
5214
|
+
address1: 208 Lovely Street
|
|
5210
5215
|
address2: Northwest
|
|
5211
5216
|
postal_code: '10118'
|
|
5212
5217
|
city: New York
|
|
@@ -5224,7 +5229,7 @@ paths:
|
|
|
5224
5229
|
- id: pm_UkLWZg9DAJ
|
|
5225
5230
|
name: Store Credit
|
|
5226
5231
|
description:
|
|
5227
|
-
type:
|
|
5232
|
+
type: store_credit
|
|
5228
5233
|
session_required: false
|
|
5229
5234
|
source_required: true
|
|
5230
5235
|
gift_card:
|
|
@@ -5299,7 +5304,7 @@ paths:
|
|
|
5299
5304
|
})
|
|
5300
5305
|
|
|
5301
5306
|
const cart = await client.carts.giftCards.remove('cart_abc123', 'gc_abc123', {
|
|
5302
|
-
|
|
5307
|
+
token: '<token>',
|
|
5303
5308
|
})
|
|
5304
5309
|
parameters:
|
|
5305
5310
|
- name: x-spree-api-key
|
|
@@ -5339,9 +5344,9 @@ paths:
|
|
|
5339
5344
|
example:
|
|
5340
5345
|
id: cart_UkLWZg9DAJ
|
|
5341
5346
|
market_id:
|
|
5342
|
-
number:
|
|
5343
|
-
token:
|
|
5344
|
-
email:
|
|
5347
|
+
number: R346935906
|
|
5348
|
+
token: TnUp7gtNGkYNxFF42EP5WkCdX5eckTK1enm
|
|
5349
|
+
email: kaleigh.conn@halvorsonfay.name
|
|
5345
5350
|
customer_note:
|
|
5346
5351
|
currency: USD
|
|
5347
5352
|
locale: en
|
|
@@ -5383,8 +5388,8 @@ paths:
|
|
|
5383
5388
|
variant_id: variant_UkLWZg9DAJ
|
|
5384
5389
|
quantity: 1
|
|
5385
5390
|
currency: USD
|
|
5386
|
-
name: Product
|
|
5387
|
-
slug: product-
|
|
5391
|
+
name: Product 967343
|
|
5392
|
+
slug: product-967343
|
|
5388
5393
|
options_text: ''
|
|
5389
5394
|
price: '10.0'
|
|
5390
5395
|
display_price: "$10.00"
|
|
@@ -5409,7 +5414,7 @@ paths:
|
|
|
5409
5414
|
digital_links: []
|
|
5410
5415
|
fulfillments:
|
|
5411
5416
|
- id: ful_UkLWZg9DAJ
|
|
5412
|
-
number:
|
|
5417
|
+
number: H52040725742
|
|
5413
5418
|
tracking: U10000
|
|
5414
5419
|
tracking_url:
|
|
5415
5420
|
cost: '100.0'
|
|
@@ -5438,7 +5443,7 @@ paths:
|
|
|
5438
5443
|
stock_location:
|
|
5439
5444
|
id: sloc_UkLWZg9DAJ
|
|
5440
5445
|
state_abbr: NY
|
|
5441
|
-
name:
|
|
5446
|
+
name: Timmy Watsica
|
|
5442
5447
|
address1: 1600 Pennsylvania Ave NW
|
|
5443
5448
|
city: Washington
|
|
5444
5449
|
zipcode: '20500'
|
|
@@ -5467,8 +5472,8 @@ paths:
|
|
|
5467
5472
|
payments:
|
|
5468
5473
|
- id: py_UkLWZg9DAJ
|
|
5469
5474
|
payment_method_id: pm_UkLWZg9DAJ
|
|
5470
|
-
response_code: 1-SC-
|
|
5471
|
-
number:
|
|
5475
|
+
response_code: 1-SC-20260512174309063312
|
|
5476
|
+
number: P07HJ2V8
|
|
5472
5477
|
amount: '50.0'
|
|
5473
5478
|
display_amount: "$50.00"
|
|
5474
5479
|
status: invalid
|
|
@@ -5487,7 +5492,7 @@ paths:
|
|
|
5487
5492
|
id: pm_UkLWZg9DAJ
|
|
5488
5493
|
name: Store Credit
|
|
5489
5494
|
description:
|
|
5490
|
-
type:
|
|
5495
|
+
type: store_credit
|
|
5491
5496
|
session_required: false
|
|
5492
5497
|
source_required: true
|
|
5493
5498
|
billing_address:
|
|
@@ -5495,7 +5500,7 @@ paths:
|
|
|
5495
5500
|
first_name: John
|
|
5496
5501
|
last_name: Doe
|
|
5497
5502
|
full_name: John Doe
|
|
5498
|
-
address1:
|
|
5503
|
+
address1: 223 Lovely Street
|
|
5499
5504
|
address2: Northwest
|
|
5500
5505
|
postal_code: '10118'
|
|
5501
5506
|
city: New York
|
|
@@ -5514,7 +5519,7 @@ paths:
|
|
|
5514
5519
|
first_name: John
|
|
5515
5520
|
last_name: Doe
|
|
5516
5521
|
full_name: John Doe
|
|
5517
|
-
address1:
|
|
5522
|
+
address1: 224 Lovely Street
|
|
5518
5523
|
address2: Northwest
|
|
5519
5524
|
postal_code: '10118'
|
|
5520
5525
|
city: New York
|
|
@@ -5554,7 +5559,7 @@ paths:
|
|
|
5554
5559
|
})
|
|
5555
5560
|
|
|
5556
5561
|
const giftCards = await client.customer.giftCards.list({}, {
|
|
5557
|
-
|
|
5562
|
+
token: '<token>',
|
|
5558
5563
|
})
|
|
5559
5564
|
parameters:
|
|
5560
5565
|
- name: x-spree-api-key
|
|
@@ -5592,7 +5597,7 @@ paths:
|
|
|
5592
5597
|
example:
|
|
5593
5598
|
data:
|
|
5594
5599
|
- id: gc_UkLWZg9DAJ
|
|
5595
|
-
code:
|
|
5600
|
+
code: 96370D6C5CBF09A9
|
|
5596
5601
|
status: active
|
|
5597
5602
|
currency: USD
|
|
5598
5603
|
amount: '10.0'
|
|
@@ -5656,7 +5661,7 @@ paths:
|
|
|
5656
5661
|
})
|
|
5657
5662
|
|
|
5658
5663
|
const giftCard = await client.customer.giftCards.get('gc_abc123', {
|
|
5659
|
-
|
|
5664
|
+
token: '<token>',
|
|
5660
5665
|
})
|
|
5661
5666
|
parameters:
|
|
5662
5667
|
- name: x-spree-api-key
|
|
@@ -5688,7 +5693,7 @@ paths:
|
|
|
5688
5693
|
application/json:
|
|
5689
5694
|
example:
|
|
5690
5695
|
id: gc_UkLWZg9DAJ
|
|
5691
|
-
code:
|
|
5696
|
+
code: 17856F2C03DD4BCC
|
|
5692
5697
|
status: active
|
|
5693
5698
|
currency: USD
|
|
5694
5699
|
amount: '10.0'
|
|
@@ -5739,7 +5744,7 @@ paths:
|
|
|
5739
5744
|
variant_id: 'variant_abc123',
|
|
5740
5745
|
quantity: 2,
|
|
5741
5746
|
}, {
|
|
5742
|
-
|
|
5747
|
+
token: '<token>',
|
|
5743
5748
|
})
|
|
5744
5749
|
parameters:
|
|
5745
5750
|
- name: x-spree-api-key
|
|
@@ -5779,9 +5784,9 @@ paths:
|
|
|
5779
5784
|
example:
|
|
5780
5785
|
id: cart_UkLWZg9DAJ
|
|
5781
5786
|
market_id:
|
|
5782
|
-
number:
|
|
5783
|
-
token:
|
|
5784
|
-
email:
|
|
5787
|
+
number: R324686344
|
|
5788
|
+
token: iY7MJ1EfNp1s3o8we9KeQm5SvqXC9eZZWsX
|
|
5789
|
+
email: jami@lind.com
|
|
5785
5790
|
customer_note:
|
|
5786
5791
|
currency: USD
|
|
5787
5792
|
locale: en
|
|
@@ -5829,8 +5834,8 @@ paths:
|
|
|
5829
5834
|
variant_id: variant_UkLWZg9DAJ
|
|
5830
5835
|
quantity: 1
|
|
5831
5836
|
currency: USD
|
|
5832
|
-
name: Product
|
|
5833
|
-
slug: product-
|
|
5837
|
+
name: Product 995930
|
|
5838
|
+
slug: product-995930
|
|
5834
5839
|
options_text: ''
|
|
5835
5840
|
price: '10.0'
|
|
5836
5841
|
display_price: "$10.00"
|
|
@@ -5857,8 +5862,8 @@ paths:
|
|
|
5857
5862
|
variant_id: variant_gbHJdmfrXB
|
|
5858
5863
|
quantity: 1
|
|
5859
5864
|
currency: USD
|
|
5860
|
-
name: Product
|
|
5861
|
-
slug: product-
|
|
5865
|
+
name: Product 1008619
|
|
5866
|
+
slug: product-1008619
|
|
5862
5867
|
options_text: ''
|
|
5863
5868
|
price: '19.99'
|
|
5864
5869
|
display_price: "$19.99"
|
|
@@ -5888,7 +5893,7 @@ paths:
|
|
|
5888
5893
|
first_name: John
|
|
5889
5894
|
last_name: Doe
|
|
5890
5895
|
full_name: John Doe
|
|
5891
|
-
address1:
|
|
5896
|
+
address1: 238 Lovely Street
|
|
5892
5897
|
address2: Northwest
|
|
5893
5898
|
postal_code: '10118'
|
|
5894
5899
|
city: New York
|
|
@@ -5963,7 +5968,7 @@ paths:
|
|
|
5963
5968
|
const cart = await client.carts.items.update('cart_abc123', 'li_abc123', {
|
|
5964
5969
|
quantity: 5,
|
|
5965
5970
|
}, {
|
|
5966
|
-
|
|
5971
|
+
token: '<token>',
|
|
5967
5972
|
})
|
|
5968
5973
|
parameters:
|
|
5969
5974
|
- name: x-spree-api-key
|
|
@@ -6001,9 +6006,9 @@ paths:
|
|
|
6001
6006
|
example:
|
|
6002
6007
|
id: cart_UkLWZg9DAJ
|
|
6003
6008
|
market_id:
|
|
6004
|
-
number:
|
|
6005
|
-
token:
|
|
6006
|
-
email:
|
|
6009
|
+
number: R917949728
|
|
6010
|
+
token: zZeBubGTyPBRZT7qC6xaqw5VRgBm75Gs4kx
|
|
6011
|
+
email: janeen_roob@cartwrightdibbert.com
|
|
6007
6012
|
customer_note:
|
|
6008
6013
|
currency: USD
|
|
6009
6014
|
locale: en
|
|
@@ -6048,8 +6053,8 @@ paths:
|
|
|
6048
6053
|
variant_id: variant_UkLWZg9DAJ
|
|
6049
6054
|
quantity: 1
|
|
6050
6055
|
currency: USD
|
|
6051
|
-
name: Product
|
|
6052
|
-
slug: product-
|
|
6056
|
+
name: Product 1038068
|
|
6057
|
+
slug: product-1038068
|
|
6053
6058
|
options_text: ''
|
|
6054
6059
|
price: '10.0'
|
|
6055
6060
|
display_price: "$10.00"
|
|
@@ -6079,7 +6084,7 @@ paths:
|
|
|
6079
6084
|
first_name: John
|
|
6080
6085
|
last_name: Doe
|
|
6081
6086
|
full_name: John Doe
|
|
6082
|
-
address1:
|
|
6087
|
+
address1: 247 Lovely Street
|
|
6083
6088
|
address2: Northwest
|
|
6084
6089
|
postal_code: '10118'
|
|
6085
6090
|
city: New York
|
|
@@ -6135,7 +6140,7 @@ paths:
|
|
|
6135
6140
|
})
|
|
6136
6141
|
|
|
6137
6142
|
const cart = await client.carts.items.delete('cart_abc123', 'li_abc123', {
|
|
6138
|
-
|
|
6143
|
+
token: '<token>',
|
|
6139
6144
|
})
|
|
6140
6145
|
parameters:
|
|
6141
6146
|
- name: x-spree-api-key
|
|
@@ -6172,9 +6177,9 @@ paths:
|
|
|
6172
6177
|
example:
|
|
6173
6178
|
id: cart_UkLWZg9DAJ
|
|
6174
6179
|
market_id:
|
|
6175
|
-
number:
|
|
6176
|
-
token:
|
|
6177
|
-
email:
|
|
6180
|
+
number: R688955093
|
|
6181
|
+
token: G7No3LxpUKmv4U9GHyb7rzGTmC85CKWh2Np
|
|
6182
|
+
email: lilliana@jakubowski.name
|
|
6178
6183
|
customer_note:
|
|
6179
6184
|
currency: USD
|
|
6180
6185
|
locale: en
|
|
@@ -6225,7 +6230,7 @@ paths:
|
|
|
6225
6230
|
first_name: John
|
|
6226
6231
|
last_name: Doe
|
|
6227
6232
|
full_name: John Doe
|
|
6228
|
-
address1:
|
|
6233
|
+
address1: 250 Lovely Street
|
|
6229
6234
|
address2: Northwest
|
|
6230
6235
|
postal_code: '10118'
|
|
6231
6236
|
city: New York
|
|
@@ -6386,12 +6391,12 @@ paths:
|
|
|
6386
6391
|
- fr
|
|
6387
6392
|
countries:
|
|
6388
6393
|
- iso: DE
|
|
6389
|
-
iso3:
|
|
6394
|
+
iso3: IS66
|
|
6390
6395
|
name: Germany
|
|
6391
6396
|
states_required: false
|
|
6392
6397
|
zipcode_required: true
|
|
6393
6398
|
- iso: FR
|
|
6394
|
-
iso3:
|
|
6399
|
+
iso3: IS67
|
|
6395
6400
|
name: France
|
|
6396
6401
|
states_required: false
|
|
6397
6402
|
zipcode_required: true
|
|
@@ -6470,12 +6475,12 @@ paths:
|
|
|
6470
6475
|
- fr
|
|
6471
6476
|
countries:
|
|
6472
6477
|
- iso: DE
|
|
6473
|
-
iso3:
|
|
6478
|
+
iso3: IS70
|
|
6474
6479
|
name: Germany
|
|
6475
6480
|
states_required: false
|
|
6476
6481
|
zipcode_required: true
|
|
6477
6482
|
- iso: FR
|
|
6478
|
-
iso3:
|
|
6483
|
+
iso3: IS71
|
|
6479
6484
|
name: France
|
|
6480
6485
|
states_required: false
|
|
6481
6486
|
zipcode_required: true
|
|
@@ -6550,12 +6555,12 @@ paths:
|
|
|
6550
6555
|
- fr
|
|
6551
6556
|
countries:
|
|
6552
6557
|
- iso: DE
|
|
6553
|
-
iso3:
|
|
6558
|
+
iso3: IS74
|
|
6554
6559
|
name: Germany
|
|
6555
6560
|
states_required: false
|
|
6556
6561
|
zipcode_required: true
|
|
6557
6562
|
- iso: FR
|
|
6558
|
-
iso3:
|
|
6563
|
+
iso3: IS75
|
|
6559
6564
|
name: France
|
|
6560
6565
|
states_required: false
|
|
6561
6566
|
zipcode_required: true
|
|
@@ -6619,12 +6624,12 @@ paths:
|
|
|
6619
6624
|
example:
|
|
6620
6625
|
data:
|
|
6621
6626
|
- iso: FR
|
|
6622
|
-
iso3:
|
|
6627
|
+
iso3: IS79
|
|
6623
6628
|
name: France
|
|
6624
6629
|
states_required: false
|
|
6625
6630
|
zipcode_required: true
|
|
6626
6631
|
- iso: DE
|
|
6627
|
-
iso3:
|
|
6632
|
+
iso3: IS78
|
|
6628
6633
|
name: Germany
|
|
6629
6634
|
states_required: false
|
|
6630
6635
|
zipcode_required: true
|
|
@@ -6725,8 +6730,8 @@ paths:
|
|
|
6725
6730
|
publishableKey: '<api-key>',
|
|
6726
6731
|
})
|
|
6727
6732
|
|
|
6728
|
-
const order = await client.orders.get('or_abc123', {
|
|
6729
|
-
|
|
6733
|
+
const order = await client.orders.get('or_abc123', {}, {
|
|
6734
|
+
token: '<token>',
|
|
6730
6735
|
})
|
|
6731
6736
|
parameters:
|
|
6732
6737
|
- name: x-spree-api-key
|
|
@@ -6775,7 +6780,8 @@ paths:
|
|
|
6775
6780
|
example:
|
|
6776
6781
|
id: or_UkLWZg9DAJ
|
|
6777
6782
|
market_id:
|
|
6778
|
-
|
|
6783
|
+
channel_id: ch_UkLWZg9DAJ
|
|
6784
|
+
number: R486765270
|
|
6779
6785
|
email: guest@example.com
|
|
6780
6786
|
customer_note:
|
|
6781
6787
|
currency: USD
|
|
@@ -6803,7 +6809,7 @@ paths:
|
|
|
6803
6809
|
display_delivery_total: "$100.00"
|
|
6804
6810
|
fulfillment_status:
|
|
6805
6811
|
payment_status:
|
|
6806
|
-
completed_at: '2026-05-
|
|
6812
|
+
completed_at: '2026-05-12T17:43:17.205Z'
|
|
6807
6813
|
store_credit_total: '0.0'
|
|
6808
6814
|
display_store_credit_total: "$0.00"
|
|
6809
6815
|
covered_by_store_credit: false
|
|
@@ -6813,8 +6819,8 @@ paths:
|
|
|
6813
6819
|
variant_id: variant_UkLWZg9DAJ
|
|
6814
6820
|
quantity: 1
|
|
6815
6821
|
currency: USD
|
|
6816
|
-
name: Product
|
|
6817
|
-
slug: product-
|
|
6822
|
+
name: Product 1074862
|
|
6823
|
+
slug: product-1074862
|
|
6818
6824
|
options_text: ''
|
|
6819
6825
|
price: '10.0'
|
|
6820
6826
|
display_price: "$10.00"
|
|
@@ -6839,7 +6845,7 @@ paths:
|
|
|
6839
6845
|
digital_links: []
|
|
6840
6846
|
fulfillments:
|
|
6841
6847
|
- id: ful_UkLWZg9DAJ
|
|
6842
|
-
number:
|
|
6848
|
+
number: H01087985983
|
|
6843
6849
|
tracking: U10000
|
|
6844
6850
|
tracking_url:
|
|
6845
6851
|
cost: '100.0'
|
|
@@ -6868,7 +6874,7 @@ paths:
|
|
|
6868
6874
|
stock_location:
|
|
6869
6875
|
id: sloc_UkLWZg9DAJ
|
|
6870
6876
|
state_abbr: NY
|
|
6871
|
-
name:
|
|
6877
|
+
name: Suzanne Ullrich
|
|
6872
6878
|
address1: 1600 Pennsylvania Ave NW
|
|
6873
6879
|
city: Washington
|
|
6874
6880
|
zipcode: '20500'
|
|
@@ -6900,7 +6906,7 @@ paths:
|
|
|
6900
6906
|
first_name: John
|
|
6901
6907
|
last_name: Doe
|
|
6902
6908
|
full_name: John Doe
|
|
6903
|
-
address1:
|
|
6909
|
+
address1: 258 Lovely Street
|
|
6904
6910
|
address2: Northwest
|
|
6905
6911
|
postal_code: '10118'
|
|
6906
6912
|
city: New York
|
|
@@ -6919,7 +6925,7 @@ paths:
|
|
|
6919
6925
|
first_name: John
|
|
6920
6926
|
last_name: Doe
|
|
6921
6927
|
full_name: John Doe
|
|
6922
|
-
address1:
|
|
6928
|
+
address1: 259 Lovely Street
|
|
6923
6929
|
address2: Northwest
|
|
6924
6930
|
postal_code: '10118'
|
|
6925
6931
|
city: New York
|
|
@@ -6972,7 +6978,7 @@ paths:
|
|
|
6972
6978
|
const session = await client.carts.paymentSessions.create('cart_abc123', {
|
|
6973
6979
|
payment_method_id: 'pm_abc123',
|
|
6974
6980
|
}, {
|
|
6975
|
-
|
|
6981
|
+
token: '<token>',
|
|
6976
6982
|
})
|
|
6977
6983
|
parameters:
|
|
6978
6984
|
- name: x-spree-api-key
|
|
@@ -7013,9 +7019,9 @@ paths:
|
|
|
7013
7019
|
id: ps_gbHJdmfrXB
|
|
7014
7020
|
status: pending
|
|
7015
7021
|
currency: USD
|
|
7016
|
-
external_id:
|
|
7022
|
+
external_id: bogus_c922ee716357dde481adfbeb
|
|
7017
7023
|
external_data:
|
|
7018
|
-
client_secret:
|
|
7024
|
+
client_secret: bogus_secret_da76eb71a444993d
|
|
7019
7025
|
customer_external_id:
|
|
7020
7026
|
expires_at:
|
|
7021
7027
|
amount: '110.0'
|
|
@@ -7025,7 +7031,7 @@ paths:
|
|
|
7025
7031
|
id: pm_UkLWZg9DAJ
|
|
7026
7032
|
name: Credit Card
|
|
7027
7033
|
description:
|
|
7028
|
-
type:
|
|
7034
|
+
type: bogus
|
|
7029
7035
|
session_required: true
|
|
7030
7036
|
source_required: true
|
|
7031
7037
|
schema:
|
|
@@ -7102,7 +7108,7 @@ paths:
|
|
|
7102
7108
|
})
|
|
7103
7109
|
|
|
7104
7110
|
const session = await client.carts.paymentSessions.get('cart_abc123', 'ps_abc123', {
|
|
7105
|
-
|
|
7111
|
+
token: '<token>',
|
|
7106
7112
|
})
|
|
7107
7113
|
responses:
|
|
7108
7114
|
'200':
|
|
@@ -7113,7 +7119,7 @@ paths:
|
|
|
7113
7119
|
id: ps_UkLWZg9DAJ
|
|
7114
7120
|
status: pending
|
|
7115
7121
|
currency: USD
|
|
7116
|
-
external_id:
|
|
7122
|
+
external_id: bogus_191ad61999cc750530423c78
|
|
7117
7123
|
external_data:
|
|
7118
7124
|
client_secret: secret_123
|
|
7119
7125
|
customer_external_id:
|
|
@@ -7125,7 +7131,7 @@ paths:
|
|
|
7125
7131
|
id: pm_UkLWZg9DAJ
|
|
7126
7132
|
name: Credit Card
|
|
7127
7133
|
description:
|
|
7128
|
-
type:
|
|
7134
|
+
type: bogus
|
|
7129
7135
|
session_required: true
|
|
7130
7136
|
source_required: true
|
|
7131
7137
|
schema:
|
|
@@ -7163,7 +7169,7 @@ paths:
|
|
|
7163
7169
|
const session = await client.carts.paymentSessions.update('cart_abc123', 'ps_abc123', {
|
|
7164
7170
|
amount: '50.00',
|
|
7165
7171
|
}, {
|
|
7166
|
-
|
|
7172
|
+
token: '<token>',
|
|
7167
7173
|
})
|
|
7168
7174
|
parameters: []
|
|
7169
7175
|
responses:
|
|
@@ -7175,7 +7181,7 @@ paths:
|
|
|
7175
7181
|
id: ps_UkLWZg9DAJ
|
|
7176
7182
|
status: pending
|
|
7177
7183
|
currency: USD
|
|
7178
|
-
external_id:
|
|
7184
|
+
external_id: bogus_c907c5180c3bc3f1c3df8822
|
|
7179
7185
|
external_data:
|
|
7180
7186
|
client_secret: secret_123
|
|
7181
7187
|
customer_external_id:
|
|
@@ -7187,7 +7193,7 @@ paths:
|
|
|
7187
7193
|
id: pm_UkLWZg9DAJ
|
|
7188
7194
|
name: Credit Card
|
|
7189
7195
|
description:
|
|
7190
|
-
type:
|
|
7196
|
+
type: bogus
|
|
7191
7197
|
session_required: true
|
|
7192
7198
|
source_required: true
|
|
7193
7199
|
schema:
|
|
@@ -7259,7 +7265,7 @@ paths:
|
|
|
7259
7265
|
const session = await client.carts.paymentSessions.complete('cart_abc123', 'ps_abc123', {
|
|
7260
7266
|
session_result: 'success',
|
|
7261
7267
|
}, {
|
|
7262
|
-
|
|
7268
|
+
token: '<token>',
|
|
7263
7269
|
})
|
|
7264
7270
|
parameters:
|
|
7265
7271
|
- name: Idempotency-Key
|
|
@@ -7277,7 +7283,7 @@ paths:
|
|
|
7277
7283
|
id: ps_UkLWZg9DAJ
|
|
7278
7284
|
status: completed
|
|
7279
7285
|
currency: USD
|
|
7280
|
-
external_id:
|
|
7286
|
+
external_id: bogus_05e9358894a73520af684eae
|
|
7281
7287
|
external_data:
|
|
7282
7288
|
client_secret: secret_123
|
|
7283
7289
|
customer_external_id:
|
|
@@ -7289,7 +7295,7 @@ paths:
|
|
|
7289
7295
|
id: pm_UkLWZg9DAJ
|
|
7290
7296
|
name: Credit Card
|
|
7291
7297
|
description:
|
|
7292
|
-
type:
|
|
7298
|
+
type: bogus
|
|
7293
7299
|
session_required: true
|
|
7294
7300
|
source_required: true
|
|
7295
7301
|
schema:
|
|
@@ -7341,7 +7347,7 @@ paths:
|
|
|
7341
7347
|
const session = await client.customer.paymentSetupSessions.create({
|
|
7342
7348
|
payment_method_id: 'pm_abc123',
|
|
7343
7349
|
}, {
|
|
7344
|
-
|
|
7350
|
+
token: '<token>',
|
|
7345
7351
|
})
|
|
7346
7352
|
parameters:
|
|
7347
7353
|
- name: x-spree-api-key
|
|
@@ -7362,8 +7368,8 @@ paths:
|
|
|
7362
7368
|
example:
|
|
7363
7369
|
id: pss_gbHJdmfrXB
|
|
7364
7370
|
status: pending
|
|
7365
|
-
external_id:
|
|
7366
|
-
external_client_secret:
|
|
7371
|
+
external_id: bogus_seti_9fbd8ac68b49e37209e510bf
|
|
7372
|
+
external_client_secret: bogus_seti_secret_033e111e14f11cf4
|
|
7367
7373
|
external_data: {}
|
|
7368
7374
|
payment_method_id: pm_UkLWZg9DAJ
|
|
7369
7375
|
payment_source_id:
|
|
@@ -7373,7 +7379,7 @@ paths:
|
|
|
7373
7379
|
id: pm_UkLWZg9DAJ
|
|
7374
7380
|
name: Credit Card
|
|
7375
7381
|
description:
|
|
7376
|
-
type:
|
|
7382
|
+
type: bogus
|
|
7377
7383
|
session_required: true
|
|
7378
7384
|
source_required: true
|
|
7379
7385
|
schema:
|
|
@@ -7452,7 +7458,7 @@ paths:
|
|
|
7452
7458
|
})
|
|
7453
7459
|
|
|
7454
7460
|
const session = await client.customer.paymentSetupSessions.get('pss_abc123', {
|
|
7455
|
-
|
|
7461
|
+
token: '<token>',
|
|
7456
7462
|
})
|
|
7457
7463
|
responses:
|
|
7458
7464
|
'200':
|
|
@@ -7462,8 +7468,8 @@ paths:
|
|
|
7462
7468
|
example:
|
|
7463
7469
|
id: pss_UkLWZg9DAJ
|
|
7464
7470
|
status: pending
|
|
7465
|
-
external_id:
|
|
7466
|
-
external_client_secret:
|
|
7471
|
+
external_id: seti_test_e1149eeaa8b0fd8f4c4f0d4d
|
|
7472
|
+
external_client_secret: seti_secret_a1e4b7171646ad8e512ad345
|
|
7467
7473
|
external_data:
|
|
7468
7474
|
client_secret: secret_123
|
|
7469
7475
|
payment_method_id: pm_UkLWZg9DAJ
|
|
@@ -7474,7 +7480,7 @@ paths:
|
|
|
7474
7480
|
id: pm_UkLWZg9DAJ
|
|
7475
7481
|
name: Credit Card
|
|
7476
7482
|
description:
|
|
7477
|
-
type:
|
|
7483
|
+
type: bogus
|
|
7478
7484
|
session_required: true
|
|
7479
7485
|
source_required: true
|
|
7480
7486
|
schema:
|
|
@@ -7528,7 +7534,7 @@ paths:
|
|
|
7528
7534
|
})
|
|
7529
7535
|
|
|
7530
7536
|
const session = await client.customer.paymentSetupSessions.complete('pss_abc123', {}, {
|
|
7531
|
-
|
|
7537
|
+
token: '<token>',
|
|
7532
7538
|
})
|
|
7533
7539
|
parameters: []
|
|
7534
7540
|
responses:
|
|
@@ -7539,8 +7545,8 @@ paths:
|
|
|
7539
7545
|
example:
|
|
7540
7546
|
id: pss_UkLWZg9DAJ
|
|
7541
7547
|
status: completed
|
|
7542
|
-
external_id:
|
|
7543
|
-
external_client_secret:
|
|
7548
|
+
external_id: seti_test_5a98e24a1ab9440cb5b5d6aa
|
|
7549
|
+
external_client_secret: seti_secret_c1f13608e67dc09b151d1012
|
|
7544
7550
|
external_data:
|
|
7545
7551
|
client_secret: secret_123
|
|
7546
7552
|
payment_method_id: pm_UkLWZg9DAJ
|
|
@@ -7551,7 +7557,7 @@ paths:
|
|
|
7551
7557
|
id: pm_UkLWZg9DAJ
|
|
7552
7558
|
name: Credit Card
|
|
7553
7559
|
description:
|
|
7554
|
-
type:
|
|
7560
|
+
type: bogus
|
|
7555
7561
|
session_required: true
|
|
7556
7562
|
source_required: true
|
|
7557
7563
|
schema:
|
|
@@ -7600,7 +7606,7 @@ paths:
|
|
|
7600
7606
|
const payment = await client.carts.payments.create('cart_abc123', {
|
|
7601
7607
|
payment_method_id: 'pm_abc123',
|
|
7602
7608
|
}, {
|
|
7603
|
-
|
|
7609
|
+
token: '<token>',
|
|
7604
7610
|
})
|
|
7605
7611
|
parameters:
|
|
7606
7612
|
- name: x-spree-api-key
|
|
@@ -7634,7 +7640,7 @@ paths:
|
|
|
7634
7640
|
id: py_UkLWZg9DAJ
|
|
7635
7641
|
payment_method_id: pm_UkLWZg9DAJ
|
|
7636
7642
|
response_code:
|
|
7637
|
-
number:
|
|
7643
|
+
number: PVLK0OI5
|
|
7638
7644
|
amount: '110.0'
|
|
7639
7645
|
display_amount: "$110.00"
|
|
7640
7646
|
status: checkout
|
|
@@ -7645,7 +7651,7 @@ paths:
|
|
|
7645
7651
|
id: pm_UkLWZg9DAJ
|
|
7646
7652
|
name: Check
|
|
7647
7653
|
description:
|
|
7648
|
-
type:
|
|
7654
|
+
type: check
|
|
7649
7655
|
session_required: false
|
|
7650
7656
|
source_required: false
|
|
7651
7657
|
schema:
|
|
@@ -7730,7 +7736,7 @@ paths:
|
|
|
7730
7736
|
body_html: ''
|
|
7731
7737
|
- id: pol_OIJLhNcSbf
|
|
7732
7738
|
name: Privacy Policy
|
|
7733
|
-
slug: privacy-policy-
|
|
7739
|
+
slug: privacy-policy-72c7f291-044e-4b7a-be02-36c3fa9bcd8c
|
|
7734
7740
|
body: We respect your privacy.
|
|
7735
7741
|
body_html: |
|
|
7736
7742
|
<div class="trix-content">
|
|
@@ -7974,12 +7980,12 @@ paths:
|
|
|
7974
7980
|
example:
|
|
7975
7981
|
data:
|
|
7976
7982
|
- id: prod_UkLWZg9DAJ
|
|
7977
|
-
name: Product
|
|
7978
|
-
slug: product-
|
|
7983
|
+
name: Product 1171313
|
|
7984
|
+
slug: product-1171313
|
|
7979
7985
|
meta_description:
|
|
7980
7986
|
meta_keywords:
|
|
7981
7987
|
variant_count: 1
|
|
7982
|
-
available_on: '2025-05-
|
|
7988
|
+
available_on: '2025-05-12T17:43:27.833Z'
|
|
7983
7989
|
purchasable: true
|
|
7984
7990
|
in_stock: false
|
|
7985
7991
|
backorderable: true
|
|
@@ -8001,22 +8007,30 @@ paths:
|
|
|
8001
8007
|
price_list_id:
|
|
8002
8008
|
original_price:
|
|
8003
8009
|
- id: prod_gbHJdmfrXB
|
|
8004
|
-
name: Product
|
|
8005
|
-
slug: product-
|
|
8010
|
+
name: Product 1184216
|
|
8011
|
+
slug: product-1184216
|
|
8006
8012
|
meta_description:
|
|
8007
8013
|
meta_keywords:
|
|
8008
8014
|
variant_count: 0
|
|
8009
|
-
available_on: '2025-05-
|
|
8015
|
+
available_on: '2025-05-12T17:43:27.892Z'
|
|
8010
8016
|
purchasable: true
|
|
8011
8017
|
in_stock: false
|
|
8012
8018
|
backorderable: true
|
|
8013
8019
|
available: true
|
|
8014
|
-
description:
|
|
8015
|
-
|
|
8016
|
-
quam
|
|
8017
|
-
|
|
8018
|
-
|
|
8019
|
-
|
|
8020
|
+
description: Incidunt hic illum neque commodi quam debitis. Corporis
|
|
8021
|
+
ducimus nulla qui alias. Ipsam soluta ab ratione voluptate quam
|
|
8022
|
+
quae corrupti dicta. Deserunt sapiente ratione quod quam. Numquam
|
|
8023
|
+
pariatur inventore aperiam ex vitae quo odio. Est asperiores numquam
|
|
8024
|
+
itaque maiores amet neque nobis aliquid. Eaque excepturi voluptas
|
|
8025
|
+
magni asperiores at. Distinctio ut veritatis quia alias maiores
|
|
8026
|
+
ullam. Praesentium dignissimos quod debitis exercitationem. Placeat
|
|
8027
|
+
excepturi quaerat dolorem aliquam. Expedita sapiente sequi aspernatur
|
|
8028
|
+
illum itaque. Natus autem libero officia voluptatum quo saepe
|
|
8029
|
+
nobis laboriosam. Hic adipisci alias quasi magnam consequatur.
|
|
8030
|
+
description_html: |-
|
|
8031
|
+
Incidunt hic illum neque commodi quam debitis. Corporis ducimus nulla qui alias. Ipsam soluta ab ratione voluptate quam quae corrupti dicta. Deserunt sapiente ratione quod quam. Numquam pariatur inventore aperiam ex vitae quo odio.
|
|
8032
|
+
Est asperiores numquam itaque maiores amet neque nobis aliquid. Eaque excepturi voluptas magni asperiores at. Distinctio ut veritatis quia alias maiores ullam.
|
|
8033
|
+
Praesentium dignissimos quod debitis exercitationem. Placeat excepturi quaerat dolorem aliquam. Expedita sapiente sequi aspernatur illum itaque. Natus autem libero officia voluptatum quo saepe nobis laboriosam. Hic adipisci alias quasi magnam consequatur.
|
|
8020
8034
|
default_variant_id: variant_EfhxLZ9ck8
|
|
8021
8035
|
thumbnail_url:
|
|
8022
8036
|
tags: []
|
|
@@ -8118,12 +8132,12 @@ paths:
|
|
|
8118
8132
|
application/json:
|
|
8119
8133
|
example:
|
|
8120
8134
|
id: prod_UkLWZg9DAJ
|
|
8121
|
-
name: Product
|
|
8122
|
-
slug: product-
|
|
8135
|
+
name: Product 1454789
|
|
8136
|
+
slug: product-1454789
|
|
8123
8137
|
meta_description:
|
|
8124
8138
|
meta_keywords:
|
|
8125
8139
|
variant_count: 1
|
|
8126
|
-
available_on: '2025-05-
|
|
8140
|
+
available_on: '2025-05-12T17:43:29.420Z'
|
|
8127
8141
|
purchasable: true
|
|
8128
8142
|
in_stock: false
|
|
8129
8143
|
backorderable: true
|
|
@@ -8150,7 +8164,7 @@ paths:
|
|
|
8150
8164
|
amount_in_cents: 999
|
|
8151
8165
|
currency: USD
|
|
8152
8166
|
display_amount: "$9.99"
|
|
8153
|
-
recorded_at: '2026-04-
|
|
8167
|
+
recorded_at: '2026-04-27T17:43:29Z'
|
|
8154
8168
|
schema:
|
|
8155
8169
|
"$ref": "#/components/schemas/Product"
|
|
8156
8170
|
'404':
|
|
@@ -8321,7 +8335,7 @@ paths:
|
|
|
8321
8335
|
})
|
|
8322
8336
|
|
|
8323
8337
|
const credits = await client.customer.storeCredits.list({}, {
|
|
8324
|
-
|
|
8338
|
+
token: '<token>',
|
|
8325
8339
|
})
|
|
8326
8340
|
parameters:
|
|
8327
8341
|
- name: x-spree-api-key
|
|
@@ -8415,7 +8429,7 @@ paths:
|
|
|
8415
8429
|
})
|
|
8416
8430
|
|
|
8417
8431
|
const credit = await client.customer.storeCredits.get('credit_abc123', {
|
|
8418
|
-
|
|
8432
|
+
token: '<token>',
|
|
8419
8433
|
})
|
|
8420
8434
|
parameters:
|
|
8421
8435
|
- name: x-spree-api-key
|
|
@@ -8487,7 +8501,7 @@ paths:
|
|
|
8487
8501
|
})
|
|
8488
8502
|
|
|
8489
8503
|
const cart = await client.carts.storeCredits.apply('cart_abc123', 10.0, {
|
|
8490
|
-
|
|
8504
|
+
token: '<token>',
|
|
8491
8505
|
})
|
|
8492
8506
|
parameters:
|
|
8493
8507
|
- name: x-spree-api-key
|
|
@@ -8525,9 +8539,9 @@ paths:
|
|
|
8525
8539
|
example:
|
|
8526
8540
|
id: cart_UkLWZg9DAJ
|
|
8527
8541
|
market_id:
|
|
8528
|
-
number:
|
|
8529
|
-
token:
|
|
8530
|
-
email:
|
|
8542
|
+
number: R388649387
|
|
8543
|
+
token: H1CEJfGaH87QSGz7kas2bJyBiLnzdGj8YD8
|
|
8544
|
+
email: tod@boehm.biz
|
|
8531
8545
|
customer_note:
|
|
8532
8546
|
currency: USD
|
|
8533
8547
|
locale: en
|
|
@@ -8566,8 +8580,8 @@ paths:
|
|
|
8566
8580
|
variant_id: variant_UkLWZg9DAJ
|
|
8567
8581
|
quantity: 1
|
|
8568
8582
|
currency: USD
|
|
8569
|
-
name: Product
|
|
8570
|
-
slug: product-
|
|
8583
|
+
name: Product 1659647
|
|
8584
|
+
slug: product-1659647
|
|
8571
8585
|
options_text: ''
|
|
8572
8586
|
price: '10.0'
|
|
8573
8587
|
display_price: "$10.00"
|
|
@@ -8592,7 +8606,7 @@ paths:
|
|
|
8592
8606
|
digital_links: []
|
|
8593
8607
|
fulfillments:
|
|
8594
8608
|
- id: ful_UkLWZg9DAJ
|
|
8595
|
-
number:
|
|
8609
|
+
number: H98502420479
|
|
8596
8610
|
tracking: U10000
|
|
8597
8611
|
tracking_url:
|
|
8598
8612
|
cost: '100.0'
|
|
@@ -8621,7 +8635,7 @@ paths:
|
|
|
8621
8635
|
stock_location:
|
|
8622
8636
|
id: sloc_UkLWZg9DAJ
|
|
8623
8637
|
state_abbr: NY
|
|
8624
|
-
name:
|
|
8638
|
+
name: Katy Wiegand
|
|
8625
8639
|
address1: 1600 Pennsylvania Ave NW
|
|
8626
8640
|
city: Washington
|
|
8627
8641
|
zipcode: '20500'
|
|
@@ -8650,8 +8664,8 @@ paths:
|
|
|
8650
8664
|
payments:
|
|
8651
8665
|
- id: py_UkLWZg9DAJ
|
|
8652
8666
|
payment_method_id: pm_UkLWZg9DAJ
|
|
8653
|
-
response_code: 1-SC-
|
|
8654
|
-
number:
|
|
8667
|
+
response_code: 1-SC-20260512174334691542
|
|
8668
|
+
number: PVZ9IG1P
|
|
8655
8669
|
amount: '10.0'
|
|
8656
8670
|
display_amount: "$10.00"
|
|
8657
8671
|
status: checkout
|
|
@@ -8670,7 +8684,7 @@ paths:
|
|
|
8670
8684
|
id: pm_UkLWZg9DAJ
|
|
8671
8685
|
name: Store Credit
|
|
8672
8686
|
description: Store Credit
|
|
8673
|
-
type:
|
|
8687
|
+
type: store_credit
|
|
8674
8688
|
session_required: false
|
|
8675
8689
|
source_required: true
|
|
8676
8690
|
billing_address:
|
|
@@ -8678,7 +8692,7 @@ paths:
|
|
|
8678
8692
|
first_name: John
|
|
8679
8693
|
last_name: Doe
|
|
8680
8694
|
full_name: John Doe
|
|
8681
|
-
address1:
|
|
8695
|
+
address1: 322 Lovely Street
|
|
8682
8696
|
address2: Northwest
|
|
8683
8697
|
postal_code: '10118'
|
|
8684
8698
|
city: New York
|
|
@@ -8697,7 +8711,7 @@ paths:
|
|
|
8697
8711
|
first_name: John
|
|
8698
8712
|
last_name: Doe
|
|
8699
8713
|
full_name: John Doe
|
|
8700
|
-
address1:
|
|
8714
|
+
address1: 323 Lovely Street
|
|
8701
8715
|
address2: Northwest
|
|
8702
8716
|
postal_code: '10118'
|
|
8703
8717
|
city: New York
|
|
@@ -8715,7 +8729,7 @@ paths:
|
|
|
8715
8729
|
- id: pm_UkLWZg9DAJ
|
|
8716
8730
|
name: Store Credit
|
|
8717
8731
|
description: Store Credit
|
|
8718
|
-
type:
|
|
8732
|
+
type: store_credit
|
|
8719
8733
|
session_required: false
|
|
8720
8734
|
source_required: true
|
|
8721
8735
|
gift_card:
|
|
@@ -8762,7 +8776,7 @@ paths:
|
|
|
8762
8776
|
})
|
|
8763
8777
|
|
|
8764
8778
|
const cart = await client.carts.storeCredits.remove('cart_abc123', {
|
|
8765
|
-
|
|
8779
|
+
token: '<token>',
|
|
8766
8780
|
})
|
|
8767
8781
|
parameters:
|
|
8768
8782
|
- name: x-spree-api-key
|
|
@@ -8794,9 +8808,9 @@ paths:
|
|
|
8794
8808
|
example:
|
|
8795
8809
|
id: cart_UkLWZg9DAJ
|
|
8796
8810
|
market_id:
|
|
8797
|
-
number:
|
|
8798
|
-
token:
|
|
8799
|
-
email:
|
|
8811
|
+
number: R743582562
|
|
8812
|
+
token: vpzZW4s6S1nZpR1jfRNjmCfRdcu1WyT4aeq
|
|
8813
|
+
email: jerold.ohara@goodwin.co.uk
|
|
8800
8814
|
customer_note:
|
|
8801
8815
|
currency: USD
|
|
8802
8816
|
locale: en
|
|
@@ -8838,8 +8852,8 @@ paths:
|
|
|
8838
8852
|
variant_id: variant_UkLWZg9DAJ
|
|
8839
8853
|
quantity: 1
|
|
8840
8854
|
currency: USD
|
|
8841
|
-
name: Product
|
|
8842
|
-
slug: product-
|
|
8855
|
+
name: Product 1678880
|
|
8856
|
+
slug: product-1678880
|
|
8843
8857
|
options_text: ''
|
|
8844
8858
|
price: '10.0'
|
|
8845
8859
|
display_price: "$10.00"
|
|
@@ -8864,7 +8878,7 @@ paths:
|
|
|
8864
8878
|
digital_links: []
|
|
8865
8879
|
fulfillments:
|
|
8866
8880
|
- id: ful_UkLWZg9DAJ
|
|
8867
|
-
number:
|
|
8881
|
+
number: H51043903970
|
|
8868
8882
|
tracking: U10000
|
|
8869
8883
|
tracking_url:
|
|
8870
8884
|
cost: '100.0'
|
|
@@ -8893,7 +8907,7 @@ paths:
|
|
|
8893
8907
|
stock_location:
|
|
8894
8908
|
id: sloc_UkLWZg9DAJ
|
|
8895
8909
|
state_abbr: NY
|
|
8896
|
-
name:
|
|
8910
|
+
name: Dana Kertzmann
|
|
8897
8911
|
address1: 1600 Pennsylvania Ave NW
|
|
8898
8912
|
city: Washington
|
|
8899
8913
|
zipcode: '20500'
|
|
@@ -8925,7 +8939,7 @@ paths:
|
|
|
8925
8939
|
first_name: John
|
|
8926
8940
|
last_name: Doe
|
|
8927
8941
|
full_name: John Doe
|
|
8928
|
-
address1:
|
|
8942
|
+
address1: 330 Lovely Street
|
|
8929
8943
|
address2: Northwest
|
|
8930
8944
|
postal_code: '10118'
|
|
8931
8945
|
city: New York
|
|
@@ -8944,7 +8958,7 @@ paths:
|
|
|
8944
8958
|
first_name: John
|
|
8945
8959
|
last_name: Doe
|
|
8946
8960
|
full_name: John Doe
|
|
8947
|
-
address1:
|
|
8961
|
+
address1: 331 Lovely Street
|
|
8948
8962
|
address2: Northwest
|
|
8949
8963
|
postal_code: '10118'
|
|
8950
8964
|
city: New York
|
|
@@ -8984,7 +8998,7 @@ paths:
|
|
|
8984
8998
|
})
|
|
8985
8999
|
|
|
8986
9000
|
const wishlists = await client.wishlists.list({}, {
|
|
8987
|
-
|
|
9001
|
+
token: '<token>',
|
|
8988
9002
|
})
|
|
8989
9003
|
parameters:
|
|
8990
9004
|
- name: x-spree-api-key
|
|
@@ -9023,7 +9037,7 @@ paths:
|
|
|
9023
9037
|
data:
|
|
9024
9038
|
- id: wl_UkLWZg9DAJ
|
|
9025
9039
|
name: My Wishlist
|
|
9026
|
-
token:
|
|
9040
|
+
token: RYftg6UdQ7Jd7tmq1kE3A3aC
|
|
9027
9041
|
is_default: false
|
|
9028
9042
|
is_private: true
|
|
9029
9043
|
meta:
|
|
@@ -9078,7 +9092,7 @@ paths:
|
|
|
9078
9092
|
name: 'Birthday Ideas',
|
|
9079
9093
|
is_private: true,
|
|
9080
9094
|
}, {
|
|
9081
|
-
|
|
9095
|
+
token: '<token>',
|
|
9082
9096
|
})
|
|
9083
9097
|
parameters:
|
|
9084
9098
|
- name: x-spree-api-key
|
|
@@ -9099,7 +9113,7 @@ paths:
|
|
|
9099
9113
|
example:
|
|
9100
9114
|
id: wl_gbHJdmfrXB
|
|
9101
9115
|
name: Birthday Ideas
|
|
9102
|
-
token:
|
|
9116
|
+
token: xga1uCSVAR2ZmoDQ7Ziu5xaw
|
|
9103
9117
|
is_default: false
|
|
9104
9118
|
is_private: true
|
|
9105
9119
|
schema:
|
|
@@ -9154,9 +9168,9 @@ paths:
|
|
|
9154
9168
|
})
|
|
9155
9169
|
|
|
9156
9170
|
const wishlist = await client.wishlists.get('wl_abc123', {
|
|
9157
|
-
expand: 'wished_items',
|
|
9171
|
+
expand: ['wished_items'],
|
|
9158
9172
|
}, {
|
|
9159
|
-
|
|
9173
|
+
token: '<token>',
|
|
9160
9174
|
})
|
|
9161
9175
|
parameters:
|
|
9162
9176
|
- name: x-spree-api-key
|
|
@@ -9195,7 +9209,7 @@ paths:
|
|
|
9195
9209
|
example:
|
|
9196
9210
|
id: wl_UkLWZg9DAJ
|
|
9197
9211
|
name: My Wishlist
|
|
9198
|
-
token:
|
|
9212
|
+
token: ot5AjNCqs9KBrFAJVBiDDbSt
|
|
9199
9213
|
is_default: false
|
|
9200
9214
|
is_private: true
|
|
9201
9215
|
schema:
|
|
@@ -9231,7 +9245,7 @@ paths:
|
|
|
9231
9245
|
const wishlist = await client.wishlists.update('wl_abc123', {
|
|
9232
9246
|
name: 'Updated Name',
|
|
9233
9247
|
}, {
|
|
9234
|
-
|
|
9248
|
+
token: '<token>',
|
|
9235
9249
|
})
|
|
9236
9250
|
parameters:
|
|
9237
9251
|
- name: x-spree-api-key
|
|
@@ -9257,7 +9271,7 @@ paths:
|
|
|
9257
9271
|
example:
|
|
9258
9272
|
id: wl_UkLWZg9DAJ
|
|
9259
9273
|
name: Updated Name
|
|
9260
|
-
token:
|
|
9274
|
+
token: 7cnDpPqgJJR6H7FJEjRZ1ak7
|
|
9261
9275
|
is_default: false
|
|
9262
9276
|
is_private: true
|
|
9263
9277
|
schema:
|
|
@@ -9296,7 +9310,7 @@ paths:
|
|
|
9296
9310
|
})
|
|
9297
9311
|
|
|
9298
9312
|
await client.wishlists.delete('wl_abc123', {
|
|
9299
|
-
|
|
9313
|
+
token: '<token>',
|
|
9300
9314
|
})
|
|
9301
9315
|
parameters:
|
|
9302
9316
|
- name: x-spree-api-key
|
|
@@ -9341,7 +9355,7 @@ paths:
|
|
|
9341
9355
|
variant_id: 'variant_abc123',
|
|
9342
9356
|
quantity: 1,
|
|
9343
9357
|
}, {
|
|
9344
|
-
|
|
9358
|
+
token: '<token>',
|
|
9345
9359
|
})
|
|
9346
9360
|
parameters:
|
|
9347
9361
|
- name: x-spree-api-key
|
|
@@ -9372,7 +9386,7 @@ paths:
|
|
|
9372
9386
|
variant:
|
|
9373
9387
|
id: variant_gbHJdmfrXB
|
|
9374
9388
|
product_id: prod_gbHJdmfrXB
|
|
9375
|
-
sku: SKU-
|
|
9389
|
+
sku: SKU-202
|
|
9376
9390
|
options_text: ''
|
|
9377
9391
|
track_inventory: true
|
|
9378
9392
|
media_count: 0
|
|
@@ -9432,7 +9446,7 @@ paths:
|
|
|
9432
9446
|
})
|
|
9433
9447
|
|
|
9434
9448
|
await client.wishlists.items.delete('wl_abc123', 'wi_abc123', {
|
|
9435
|
-
|
|
9449
|
+
token: '<token>',
|
|
9436
9450
|
})
|
|
9437
9451
|
parameters:
|
|
9438
9452
|
- name: x-spree-api-key
|
|
@@ -9734,6 +9748,79 @@ components:
|
|
|
9734
9748
|
- item_id
|
|
9735
9749
|
- variant_id
|
|
9736
9750
|
- quantity
|
|
9751
|
+
AdminUserRoleAssignment:
|
|
9752
|
+
type: object
|
|
9753
|
+
description: A role assignment for the current store on a staff member
|
|
9754
|
+
properties:
|
|
9755
|
+
id:
|
|
9756
|
+
type: string
|
|
9757
|
+
description: Prefixed role ID
|
|
9758
|
+
example: role_abc123
|
|
9759
|
+
name:
|
|
9760
|
+
type: string
|
|
9761
|
+
description: Role name
|
|
9762
|
+
example: admin
|
|
9763
|
+
required:
|
|
9764
|
+
- id
|
|
9765
|
+
- name
|
|
9766
|
+
PreferenceField:
|
|
9767
|
+
type: object
|
|
9768
|
+
description: A single configurable preference on a payment method, promotion
|
|
9769
|
+
rule/action, or calculator. The frontend uses `type` + `default` to render
|
|
9770
|
+
a sensible input.
|
|
9771
|
+
properties:
|
|
9772
|
+
key:
|
|
9773
|
+
type: string
|
|
9774
|
+
example: amount_min
|
|
9775
|
+
type:
|
|
9776
|
+
type: string
|
|
9777
|
+
example: decimal
|
|
9778
|
+
description: string | text | password | integer | decimal | boolean | array
|
|
9779
|
+
| hash
|
|
9780
|
+
default:
|
|
9781
|
+
description: Default value (any JSON type), null when there is no default
|
|
9782
|
+
nullable: true
|
|
9783
|
+
required:
|
|
9784
|
+
- key
|
|
9785
|
+
- type
|
|
9786
|
+
PromotionActionCalculator:
|
|
9787
|
+
type: object
|
|
9788
|
+
description: The action's nested calculator (when the action carries one — null
|
|
9789
|
+
for actions like `free_shipping`)
|
|
9790
|
+
properties:
|
|
9791
|
+
type:
|
|
9792
|
+
type: string
|
|
9793
|
+
example: flat_rate
|
|
9794
|
+
description: Wire shorthand for the calculator subclass
|
|
9795
|
+
label:
|
|
9796
|
+
type: string
|
|
9797
|
+
example: Flat Rate
|
|
9798
|
+
preferences:
|
|
9799
|
+
type: object
|
|
9800
|
+
additionalProperties: true
|
|
9801
|
+
preference_schema:
|
|
9802
|
+
type: array
|
|
9803
|
+
items:
|
|
9804
|
+
"$ref": "#/components/schemas/PreferenceField"
|
|
9805
|
+
required:
|
|
9806
|
+
- type
|
|
9807
|
+
- label
|
|
9808
|
+
- preferences
|
|
9809
|
+
- preference_schema
|
|
9810
|
+
PromotionActionLineItem:
|
|
9811
|
+
type: object
|
|
9812
|
+
description: One row in a `create_line_items` action — the variant added to
|
|
9813
|
+
the order and how many
|
|
9814
|
+
properties:
|
|
9815
|
+
variant_id:
|
|
9816
|
+
type: string
|
|
9817
|
+
example: variant_abc123
|
|
9818
|
+
quantity:
|
|
9819
|
+
type: integer
|
|
9820
|
+
example: 1
|
|
9821
|
+
required:
|
|
9822
|
+
- variant_id
|
|
9823
|
+
- quantity
|
|
9737
9824
|
Address:
|
|
9738
9825
|
type: object
|
|
9739
9826
|
properties:
|
|
@@ -10059,6 +10146,23 @@ components:
|
|
|
10059
10146
|
- is_child
|
|
10060
10147
|
- is_leaf
|
|
10061
10148
|
x-typelizer: true
|
|
10149
|
+
Channel:
|
|
10150
|
+
type: object
|
|
10151
|
+
properties:
|
|
10152
|
+
id:
|
|
10153
|
+
type: string
|
|
10154
|
+
name:
|
|
10155
|
+
type: string
|
|
10156
|
+
code:
|
|
10157
|
+
type: string
|
|
10158
|
+
active:
|
|
10159
|
+
type: boolean
|
|
10160
|
+
required:
|
|
10161
|
+
- id
|
|
10162
|
+
- name
|
|
10163
|
+
- code
|
|
10164
|
+
- active
|
|
10165
|
+
x-typelizer: true
|
|
10062
10166
|
Country:
|
|
10063
10167
|
type: object
|
|
10064
10168
|
properties:
|
|
@@ -10875,6 +10979,9 @@ components:
|
|
|
10875
10979
|
market_id:
|
|
10876
10980
|
type: string
|
|
10877
10981
|
nullable: true
|
|
10982
|
+
channel_id:
|
|
10983
|
+
type: string
|
|
10984
|
+
nullable: true
|
|
10878
10985
|
number:
|
|
10879
10986
|
type: string
|
|
10880
10987
|
email:
|
|
@@ -10979,6 +11086,7 @@ components:
|
|
|
10979
11086
|
required:
|
|
10980
11087
|
- id
|
|
10981
11088
|
- market_id
|
|
11089
|
+
- channel_id
|
|
10982
11090
|
- number
|
|
10983
11091
|
- email
|
|
10984
11092
|
- customer_note
|
|
@@ -11547,6 +11655,14 @@ components:
|
|
|
11547
11655
|
- country_name
|
|
11548
11656
|
- state_text
|
|
11549
11657
|
x-typelizer: true
|
|
11658
|
+
StockReservation:
|
|
11659
|
+
type: object
|
|
11660
|
+
properties:
|
|
11661
|
+
id:
|
|
11662
|
+
type: string
|
|
11663
|
+
required:
|
|
11664
|
+
- id
|
|
11665
|
+
x-typelizer: true
|
|
11550
11666
|
StoreCredit:
|
|
11551
11667
|
type: object
|
|
11552
11668
|
properties:
|