@vendure/docs 0.0.0-202601211352 → 0.0.0-202601211412
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.
- package/docs/reference/graphql-api/admin/enums.mdx +60 -28
- package/docs/reference/graphql-api/admin/input-types.mdx +663 -221
- package/docs/reference/graphql-api/admin/mutations.mdx +513 -171
- package/docs/reference/graphql-api/admin/object-types.mdx +702 -234
- package/docs/reference/graphql-api/admin/queries.mdx +237 -79
- package/docs/reference/graphql-api/shop/enums.mdx +48 -24
- package/docs/reference/graphql-api/shop/input-types.mdx +153 -51
- package/docs/reference/graphql-api/shop/mutations.mdx +93 -31
- package/docs/reference/graphql-api/shop/object-types.mdx +507 -169
- package/docs/reference/graphql-api/shop/queries.mdx +57 -19
- package/package.json +1 -1
|
@@ -5,7 +5,9 @@ generated: true
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
<a name="additemtoorder"></a>
|
|
9
|
+
|
|
10
|
+
## addItemToOrder
|
|
9
11
|
|
|
10
12
|
<GraphQLDoc
|
|
11
13
|
type="mutation"
|
|
@@ -22,7 +24,9 @@ type Mutation {
|
|
|
22
24
|
}`}
|
|
23
25
|
</GraphQLDoc>
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
<a name="additemstoorder"></a>
|
|
28
|
+
|
|
29
|
+
## addItemsToOrder
|
|
26
30
|
|
|
27
31
|
<GraphQLDoc
|
|
28
32
|
type="mutation"
|
|
@@ -38,7 +42,9 @@ type Mutation {
|
|
|
38
42
|
}`}
|
|
39
43
|
</GraphQLDoc>
|
|
40
44
|
|
|
41
|
-
|
|
45
|
+
<a name="addpaymenttoorder"></a>
|
|
46
|
+
|
|
47
|
+
## addPaymentToOrder
|
|
42
48
|
|
|
43
49
|
<GraphQLDoc
|
|
44
50
|
type="mutation"
|
|
@@ -54,7 +60,9 @@ type Mutation {
|
|
|
54
60
|
}`}
|
|
55
61
|
</GraphQLDoc>
|
|
56
62
|
|
|
57
|
-
|
|
63
|
+
<a name="adjustorderline"></a>
|
|
64
|
+
|
|
65
|
+
## adjustOrderLine
|
|
58
66
|
|
|
59
67
|
<GraphQLDoc
|
|
60
68
|
type="mutation"
|
|
@@ -71,7 +79,9 @@ type Mutation {
|
|
|
71
79
|
}`}
|
|
72
80
|
</GraphQLDoc>
|
|
73
81
|
|
|
74
|
-
|
|
82
|
+
<a name="applycouponcode"></a>
|
|
83
|
+
|
|
84
|
+
## applyCouponCode
|
|
75
85
|
|
|
76
86
|
<GraphQLDoc
|
|
77
87
|
type="mutation"
|
|
@@ -87,7 +97,9 @@ type Mutation {
|
|
|
87
97
|
}`}
|
|
88
98
|
</GraphQLDoc>
|
|
89
99
|
|
|
90
|
-
|
|
100
|
+
<a name="authenticate"></a>
|
|
101
|
+
|
|
102
|
+
## authenticate
|
|
91
103
|
|
|
92
104
|
<GraphQLDoc
|
|
93
105
|
type="mutation"
|
|
@@ -104,7 +116,9 @@ type Mutation {
|
|
|
104
116
|
}`}
|
|
105
117
|
</GraphQLDoc>
|
|
106
118
|
|
|
107
|
-
|
|
119
|
+
<a name="createcustomeraddress"></a>
|
|
120
|
+
|
|
121
|
+
## createCustomerAddress
|
|
108
122
|
|
|
109
123
|
<GraphQLDoc
|
|
110
124
|
type="mutation"
|
|
@@ -120,7 +134,9 @@ type Mutation {
|
|
|
120
134
|
}`}
|
|
121
135
|
</GraphQLDoc>
|
|
122
136
|
|
|
123
|
-
|
|
137
|
+
<a name="deletecustomeraddress"></a>
|
|
138
|
+
|
|
139
|
+
## deleteCustomerAddress
|
|
124
140
|
|
|
125
141
|
<GraphQLDoc
|
|
126
142
|
type="mutation"
|
|
@@ -136,7 +152,9 @@ type Mutation {
|
|
|
136
152
|
}`}
|
|
137
153
|
</GraphQLDoc>
|
|
138
154
|
|
|
139
|
-
|
|
155
|
+
<a name="login"></a>
|
|
156
|
+
|
|
157
|
+
## login
|
|
140
158
|
|
|
141
159
|
<GraphQLDoc
|
|
142
160
|
type="mutation"
|
|
@@ -158,7 +176,9 @@ type Mutation {
|
|
|
158
176
|
}`}
|
|
159
177
|
</GraphQLDoc>
|
|
160
178
|
|
|
161
|
-
|
|
179
|
+
<a name="logout"></a>
|
|
180
|
+
|
|
181
|
+
## logout
|
|
162
182
|
|
|
163
183
|
<GraphQLDoc
|
|
164
184
|
type="mutation"
|
|
@@ -173,7 +193,9 @@ type Mutation {
|
|
|
173
193
|
}`}
|
|
174
194
|
</GraphQLDoc>
|
|
175
195
|
|
|
176
|
-
|
|
196
|
+
<a name="refreshcustomerverification"></a>
|
|
197
|
+
|
|
198
|
+
## refreshCustomerVerification
|
|
177
199
|
|
|
178
200
|
<GraphQLDoc
|
|
179
201
|
type="mutation"
|
|
@@ -189,7 +211,9 @@ type Mutation {
|
|
|
189
211
|
}`}
|
|
190
212
|
</GraphQLDoc>
|
|
191
213
|
|
|
192
|
-
|
|
214
|
+
<a name="registercustomeraccount"></a>
|
|
215
|
+
|
|
216
|
+
## registerCustomerAccount
|
|
193
217
|
|
|
194
218
|
<GraphQLDoc
|
|
195
219
|
type="mutation"
|
|
@@ -220,7 +244,9 @@ type Mutation {
|
|
|
220
244
|
}`}
|
|
221
245
|
</GraphQLDoc>
|
|
222
246
|
|
|
223
|
-
|
|
247
|
+
<a name="removeallorderlines"></a>
|
|
248
|
+
|
|
249
|
+
## removeAllOrderLines
|
|
224
250
|
|
|
225
251
|
<GraphQLDoc
|
|
226
252
|
type="mutation"
|
|
@@ -235,7 +261,9 @@ type Mutation {
|
|
|
235
261
|
}`}
|
|
236
262
|
</GraphQLDoc>
|
|
237
263
|
|
|
238
|
-
|
|
264
|
+
<a name="removecouponcode"></a>
|
|
265
|
+
|
|
266
|
+
## removeCouponCode
|
|
239
267
|
|
|
240
268
|
<GraphQLDoc
|
|
241
269
|
type="mutation"
|
|
@@ -251,7 +279,9 @@ type Mutation {
|
|
|
251
279
|
}`}
|
|
252
280
|
</GraphQLDoc>
|
|
253
281
|
|
|
254
|
-
|
|
282
|
+
<a name="removeorderline"></a>
|
|
283
|
+
|
|
284
|
+
## removeOrderLine
|
|
255
285
|
|
|
256
286
|
<GraphQLDoc
|
|
257
287
|
type="mutation"
|
|
@@ -267,7 +297,9 @@ type Mutation {
|
|
|
267
297
|
}`}
|
|
268
298
|
</GraphQLDoc>
|
|
269
299
|
|
|
270
|
-
|
|
300
|
+
<a name="requestpasswordreset"></a>
|
|
301
|
+
|
|
302
|
+
## requestPasswordReset
|
|
271
303
|
|
|
272
304
|
<GraphQLDoc
|
|
273
305
|
type="mutation"
|
|
@@ -283,7 +315,9 @@ type Mutation {
|
|
|
283
315
|
}`}
|
|
284
316
|
</GraphQLDoc>
|
|
285
317
|
|
|
286
|
-
|
|
318
|
+
<a name="requestupdatecustomeremailaddress"></a>
|
|
319
|
+
|
|
320
|
+
## requestUpdateCustomerEmailAddress
|
|
287
321
|
|
|
288
322
|
<GraphQLDoc
|
|
289
323
|
type="mutation"
|
|
@@ -304,7 +338,9 @@ type Mutation {
|
|
|
304
338
|
}`}
|
|
305
339
|
</GraphQLDoc>
|
|
306
340
|
|
|
307
|
-
|
|
341
|
+
<a name="resetpassword"></a>
|
|
342
|
+
|
|
343
|
+
## resetPassword
|
|
308
344
|
|
|
309
345
|
<GraphQLDoc
|
|
310
346
|
type="mutation"
|
|
@@ -320,7 +356,9 @@ type Mutation {
|
|
|
320
356
|
}`}
|
|
321
357
|
</GraphQLDoc>
|
|
322
358
|
|
|
323
|
-
|
|
359
|
+
<a name="setcustomerfororder"></a>
|
|
360
|
+
|
|
361
|
+
## setCustomerForOrder
|
|
324
362
|
|
|
325
363
|
<GraphQLDoc
|
|
326
364
|
type="mutation"
|
|
@@ -336,7 +374,9 @@ type Mutation {
|
|
|
336
374
|
}`}
|
|
337
375
|
</GraphQLDoc>
|
|
338
376
|
|
|
339
|
-
|
|
377
|
+
<a name="setorderbillingaddress"></a>
|
|
378
|
+
|
|
379
|
+
## setOrderBillingAddress
|
|
340
380
|
|
|
341
381
|
<GraphQLDoc
|
|
342
382
|
type="mutation"
|
|
@@ -352,7 +392,9 @@ type Mutation {
|
|
|
352
392
|
}`}
|
|
353
393
|
</GraphQLDoc>
|
|
354
394
|
|
|
355
|
-
|
|
395
|
+
<a name="setordercustomfields"></a>
|
|
396
|
+
|
|
397
|
+
## setOrderCustomFields
|
|
356
398
|
|
|
357
399
|
<GraphQLDoc
|
|
358
400
|
type="mutation"
|
|
@@ -368,7 +410,9 @@ type Mutation {
|
|
|
368
410
|
}`}
|
|
369
411
|
</GraphQLDoc>
|
|
370
412
|
|
|
371
|
-
|
|
413
|
+
<a name="setordershippingaddress"></a>
|
|
414
|
+
|
|
415
|
+
## setOrderShippingAddress
|
|
372
416
|
|
|
373
417
|
<GraphQLDoc
|
|
374
418
|
type="mutation"
|
|
@@ -384,7 +428,9 @@ type Mutation {
|
|
|
384
428
|
}`}
|
|
385
429
|
</GraphQLDoc>
|
|
386
430
|
|
|
387
|
-
|
|
431
|
+
<a name="setordershippingmethod"></a>
|
|
432
|
+
|
|
433
|
+
## setOrderShippingMethod
|
|
388
434
|
|
|
389
435
|
<GraphQLDoc
|
|
390
436
|
type="mutation"
|
|
@@ -405,7 +451,9 @@ type Mutation {
|
|
|
405
451
|
}`}
|
|
406
452
|
</GraphQLDoc>
|
|
407
453
|
|
|
408
|
-
|
|
454
|
+
<a name="transitionordertostate"></a>
|
|
455
|
+
|
|
456
|
+
## transitionOrderToState
|
|
409
457
|
|
|
410
458
|
<GraphQLDoc
|
|
411
459
|
type="mutation"
|
|
@@ -421,7 +469,9 @@ type Mutation {
|
|
|
421
469
|
}`}
|
|
422
470
|
</GraphQLDoc>
|
|
423
471
|
|
|
424
|
-
|
|
472
|
+
<a name="unsetorderbillingaddress"></a>
|
|
473
|
+
|
|
474
|
+
## unsetOrderBillingAddress
|
|
425
475
|
|
|
426
476
|
<GraphQLDoc
|
|
427
477
|
type="mutation"
|
|
@@ -436,7 +486,9 @@ type Mutation {
|
|
|
436
486
|
}`}
|
|
437
487
|
</GraphQLDoc>
|
|
438
488
|
|
|
439
|
-
|
|
489
|
+
<a name="unsetordershippingaddress"></a>
|
|
490
|
+
|
|
491
|
+
## unsetOrderShippingAddress
|
|
440
492
|
|
|
441
493
|
<GraphQLDoc
|
|
442
494
|
type="mutation"
|
|
@@ -451,7 +503,9 @@ type Mutation {
|
|
|
451
503
|
}`}
|
|
452
504
|
</GraphQLDoc>
|
|
453
505
|
|
|
454
|
-
|
|
506
|
+
<a name="updatecustomer"></a>
|
|
507
|
+
|
|
508
|
+
## updateCustomer
|
|
455
509
|
|
|
456
510
|
<GraphQLDoc
|
|
457
511
|
type="mutation"
|
|
@@ -467,7 +521,9 @@ type Mutation {
|
|
|
467
521
|
}`}
|
|
468
522
|
</GraphQLDoc>
|
|
469
523
|
|
|
470
|
-
|
|
524
|
+
<a name="updatecustomeraddress"></a>
|
|
525
|
+
|
|
526
|
+
## updateCustomerAddress
|
|
471
527
|
|
|
472
528
|
<GraphQLDoc
|
|
473
529
|
type="mutation"
|
|
@@ -483,7 +539,9 @@ type Mutation {
|
|
|
483
539
|
}`}
|
|
484
540
|
</GraphQLDoc>
|
|
485
541
|
|
|
486
|
-
|
|
542
|
+
<a name="updatecustomeremailaddress"></a>
|
|
543
|
+
|
|
544
|
+
## updateCustomerEmailAddress
|
|
487
545
|
|
|
488
546
|
<GraphQLDoc
|
|
489
547
|
type="mutation"
|
|
@@ -502,7 +560,9 @@ type Mutation {
|
|
|
502
560
|
}`}
|
|
503
561
|
</GraphQLDoc>
|
|
504
562
|
|
|
505
|
-
|
|
563
|
+
<a name="updatecustomerpassword"></a>
|
|
564
|
+
|
|
565
|
+
## updateCustomerPassword
|
|
506
566
|
|
|
507
567
|
<GraphQLDoc
|
|
508
568
|
type="mutation"
|
|
@@ -518,7 +578,9 @@ type Mutation {
|
|
|
518
578
|
}`}
|
|
519
579
|
</GraphQLDoc>
|
|
520
580
|
|
|
521
|
-
|
|
581
|
+
<a name="verifycustomeraccount"></a>
|
|
582
|
+
|
|
583
|
+
## verifyCustomerAccount
|
|
522
584
|
|
|
523
585
|
<GraphQLDoc
|
|
524
586
|
type="mutation"
|