n8n-nodes-commercetools 0.1.8 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/README.md +361 -11
  2. package/dist/credentials/CommerceToolsOAuth2Api.credentials.js +30 -0
  3. package/dist/credentials/CommerceToolsOAuth2Api.credentials.js.map +1 -1
  4. package/dist/nodes/Commercetools/Commercetools.node.js.map +1 -1
  5. package/dist/nodes/Commercetools/CommercetoolsTrigger.node.d.ts +19 -0
  6. package/dist/nodes/Commercetools/CommercetoolsTrigger.node.js +57 -0
  7. package/dist/nodes/Commercetools/CommercetoolsTrigger.node.js.map +1 -0
  8. package/dist/nodes/Commercetools/CommercetoolsTrigger.node.json +21 -0
  9. package/dist/nodes/Commercetools/descriptions/Commercetools.description.js +68 -3433
  10. package/dist/nodes/Commercetools/descriptions/Commercetools.description.js.map +1 -1
  11. package/dist/nodes/Commercetools/descriptions/customer.description.d.ts +3 -0
  12. package/dist/nodes/Commercetools/descriptions/customer.description.js +1621 -0
  13. package/dist/nodes/Commercetools/descriptions/customer.description.js.map +1 -0
  14. package/dist/nodes/Commercetools/operations/product.operations.js +2 -2
  15. package/dist/nodes/Commercetools/operations/product.operations.js.map +1 -1
  16. package/dist/nodes/Commercetools/properties/category.properties.d.ts +4 -0
  17. package/dist/nodes/Commercetools/properties/category.properties.js +477 -0
  18. package/dist/nodes/Commercetools/properties/category.properties.js.map +1 -0
  19. package/dist/nodes/Commercetools/properties/product.properties.d.ts +5 -0
  20. package/dist/nodes/Commercetools/properties/product.properties.js +2873 -0
  21. package/dist/nodes/Commercetools/properties/product.properties.js.map +1 -0
  22. package/dist/nodes/Commercetools/properties/subscription.properties.d.ts +2 -0
  23. package/dist/nodes/Commercetools/properties/subscription.properties.js +29 -0
  24. package/dist/nodes/Commercetools/properties/subscription.properties.js.map +1 -0
  25. package/dist/nodes/Commercetools/utils/awsInfra.utils.d.ts +21 -0
  26. package/dist/nodes/Commercetools/utils/awsInfra.utils.js +338 -0
  27. package/dist/nodes/Commercetools/utils/awsInfra.utils.js.map +1 -0
  28. package/dist/nodes/Commercetools/utils/product.utils.d.ts +2 -1
  29. package/dist/nodes/Commercetools/utils/product.utils.js +382 -52
  30. package/dist/nodes/Commercetools/utils/product.utils.js.map +1 -1
  31. package/dist/nodes/Commercetools/utils/subscription.utils.d.ts +12 -0
  32. package/dist/nodes/Commercetools/utils/subscription.utils.js +79 -0
  33. package/dist/nodes/Commercetools/utils/subscription.utils.js.map +1 -0
  34. package/dist/nodes/Commercetools/utils/webhookMethods.utils.d.ts +8 -0
  35. package/dist/nodes/Commercetools/utils/webhookMethods.utils.js +174 -0
  36. package/dist/nodes/Commercetools/utils/webhookMethods.utils.js.map +1 -0
  37. package/dist/package.json +13 -15
  38. package/dist/tsconfig.tsbuildinfo +1 -1
  39. package/package.json +61 -53
@@ -2,11 +2,67 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.commercetoolsDescription = void 0;
4
4
  const n8n_workflow_1 = require("n8n-workflow");
5
+ const product_properties_1 = require("../properties/product.properties");
6
+ const category_properties_1 = require("../properties/category.properties");
7
+ const customer_description_1 = require("./customer.description");
8
+ const resourceField = {
9
+ displayName: 'Resource',
10
+ name: 'resource',
11
+ type: 'options',
12
+ noDataExpression: true,
13
+ options: [
14
+ {
15
+ name: 'Product',
16
+ value: 'product',
17
+ },
18
+ {
19
+ name: 'Category',
20
+ value: 'category',
21
+ },
22
+ {
23
+ name: 'Customer',
24
+ value: 'customer',
25
+ },
26
+ ],
27
+ default: 'product',
28
+ };
29
+ const sharedProductCategoryFields = [
30
+ {
31
+ displayName: 'Version',
32
+ name: 'version',
33
+ type: 'number',
34
+ typeOptions: {
35
+ minValue: 0,
36
+ },
37
+ default: 0,
38
+ required: true,
39
+ displayOptions: {
40
+ show: {
41
+ resource: ['product', 'category'],
42
+ operation: ['update', 'updateByKey', 'delete', 'deleteByKey'],
43
+ },
44
+ },
45
+ description: 'Current version of the resource to ensure optimistic concurrency control',
46
+ },
47
+ {
48
+ displayName: 'Actions (JSON)',
49
+ name: 'actions',
50
+ type: 'json',
51
+ default: '[]',
52
+ description: 'Update actions to apply to the resource',
53
+ displayOptions: {
54
+ show: {
55
+ resource: ['product', 'category'],
56
+ operation: ['update', 'updateByKey'],
57
+ },
58
+ },
59
+ }
60
+ ];
5
61
  const nodeGroup = {
6
62
  group: ['transform'],
7
63
  };
8
64
  exports.commercetoolsDescription = {
9
- displayName: 'Commercetools',
65
+ displayName: 'Commercetools Actions',
10
66
  name: 'Commercetools',
11
67
  icon: 'file:Commercetools.svg',
12
68
  ...nodeGroup,
@@ -25,3438 +81,17 @@ exports.commercetoolsDescription = {
25
81
  },
26
82
  ],
27
83
  properties: [
28
- {
29
- displayName: 'Resource',
30
- name: 'resource',
31
- type: 'options',
32
- noDataExpression: true,
33
- options: [
34
- {
35
- name: 'Product',
36
- value: 'product',
37
- },
38
- {
39
- name: 'Category',
40
- value: 'category',
41
- },
42
- {
43
- name: 'Customer',
44
- value: 'customer',
45
- },
46
- ],
47
- default: 'product',
48
- },
49
- {
50
- displayName: 'Operation',
51
- name: 'operation',
52
- type: 'options',
53
- noDataExpression: true,
54
- options: [
55
- {
56
- name: 'Check Existence',
57
- value: 'head',
58
- action: 'Check if product exists',
59
- description: 'Check whether a product exists by ID',
60
- },
61
- {
62
- name: 'Check Existence By Key',
63
- value: 'headByKey',
64
- action: 'Check if product exists by key',
65
- description: 'Check whether a product exists using its key',
66
- },
67
- {
68
- name: 'Check Existence By Query',
69
- value: 'headByQuery',
70
- action: 'Check if any product matches the query',
71
- description: 'Send a HEAD request with query predicates to check for matches',
72
- },
73
- {
74
- name: 'Create',
75
- value: 'create',
76
- action: 'Create product',
77
- description: 'Create a product draft',
78
- },
79
- {
80
- name: 'Delete',
81
- value: 'delete',
82
- action: 'Delete product',
83
- description: 'Delete a product by ID',
84
- },
85
- {
86
- name: 'Delete By Key',
87
- value: 'deleteByKey',
88
- action: 'Delete product by key',
89
- description: 'Delete a product using its key',
90
- },
91
- {
92
- name: 'Get',
93
- value: 'get',
94
- action: 'Get product',
95
- description: 'Retrieve a product by ID',
96
- },
97
- {
98
- name: 'Get By Key',
99
- value: 'getByKey',
100
- action: 'Get product by key',
101
- description: 'Retrieve a product using its key',
102
- },
103
- {
104
- name: 'Query',
105
- value: 'query',
106
- action: 'Query products',
107
- description: 'Retrieve products using the Composable Commerce Products endpoint',
108
- },
109
- {
110
- name: 'Query Product Selections',
111
- value: 'querySelections',
112
- action: 'Query product selections by product ID',
113
- description: 'List product selections assigned to a product by ID',
114
- },
115
- {
116
- name: 'Query Product Selections By Key',
117
- value: 'querySelectionsByKey',
118
- action: 'Query product selections by product key',
119
- description: 'List product selections assigned to a product by key',
120
- },
121
- {
122
- name: 'Search',
123
- value: 'search',
124
- action: 'Search products',
125
- description: 'Full-text product search using the product search endpoint',
126
- },
127
- {
128
- name: 'Update',
129
- value: 'update',
130
- action: 'Update product',
131
- description: 'Perform update actions on a product by ID',
132
- },
133
- {
134
- name: 'Update By Key',
135
- value: 'updateByKey',
136
- action: 'Update product by key',
137
- description: 'Perform update actions on a product by key',
138
- },
139
- {
140
- name: 'Upload Image',
141
- value: 'uploadImage',
142
- action: 'Upload product image',
143
- description: 'Upload an image to a product variant',
144
- },
145
- ],
146
- default: 'query',
147
- displayOptions: {
148
- show: {
149
- resource: ['product'],
150
- },
151
- },
152
- },
153
- {
154
- displayName: 'Operation',
155
- name: 'operation',
156
- type: 'options',
157
- noDataExpression: true,
158
- options: [
159
- {
160
- name: 'Create',
161
- value: 'create',
162
- action: 'Create category',
163
- description: 'Create a new category draft',
164
- },
165
- {
166
- name: 'Delete',
167
- value: 'delete',
168
- action: 'Delete category',
169
- description: 'Delete a category by ID',
170
- },
171
- {
172
- name: 'Delete By Key',
173
- value: 'deleteByKey',
174
- action: 'Delete category by key',
175
- description: 'Delete a category using its unique key',
176
- },
177
- {
178
- name: 'Get',
179
- value: 'get',
180
- action: 'Get category',
181
- description: 'Retrieve a category by ID',
182
- },
183
- {
184
- name: 'Get By Key',
185
- value: 'getByKey',
186
- action: 'Get category by key',
187
- description: 'Retrieve a category using its key',
188
- },
189
- {
190
- name: 'Query',
191
- value: 'query',
192
- action: 'Query categories',
193
- description: 'List categories using the Composable Commerce Categories endpoint',
194
- },
195
- {
196
- name: 'Update',
197
- value: 'update',
198
- action: 'Update category',
199
- description: 'Perform update actions on a category by ID',
200
- },
201
- {
202
- name: 'Update By Key',
203
- value: 'updateByKey',
204
- action: 'Update category by key',
205
- description: 'Perform update actions on a category by key',
206
- },
207
- ],
208
- default: 'query',
209
- displayOptions: {
210
- show: {
211
- resource: ['category'],
212
- },
213
- },
214
- },
215
- {
216
- displayName: 'Operation',
217
- name: 'operation',
218
- type: 'options',
219
- noDataExpression: true,
220
- options: [
221
- {
222
- name: 'Authenticate (Sign In)',
223
- value: 'authenticate',
224
- action: 'Authenticate customer',
225
- description: 'Sign in a customer with email and password',
226
- },
227
- {
228
- name: 'Authenticate in Store',
229
- value: 'authenticateInStore',
230
- action: 'Authenticate customer in store',
231
- description: 'Sign in a customer with email and password in a specific store',
232
- },
233
- {
234
- name: 'Change Password',
235
- value: 'changePassword',
236
- action: 'Change customer password',
237
- description: 'Change password of a customer',
238
- },
239
- {
240
- name: 'Change Password in Store',
241
- value: 'changePasswordInStore',
242
- action: 'Change customer password in store',
243
- description: 'Change password of a customer in a specific store',
244
- },
245
- {
246
- name: 'Check Existence',
247
- value: 'head',
248
- action: 'Check if customer exists',
249
- description: 'Check whether a customer exists by ID',
250
- },
251
- {
252
- name: 'Check Existence By Key',
253
- value: 'headByKey',
254
- action: 'Check if customer exists by key',
255
- description: 'Check whether a customer exists using its key',
256
- },
257
- {
258
- name: 'Check Existence By Query',
259
- value: 'headByQuery',
260
- action: 'Check if any customer matches the query',
261
- description: 'Send a HEAD request with query predicates to check for matches',
262
- },
263
- {
264
- name: 'Check Existence in Store',
265
- value: 'headInStore',
266
- action: 'Check if customer exists in store',
267
- description: 'Check whether a customer exists by ID in a specific store',
268
- },
269
- {
270
- name: 'Check Existence in Store By Key',
271
- value: 'headInStoreByKey',
272
- action: 'Check if customer exists in store by key',
273
- description: 'Check whether a customer exists by key in a specific store',
274
- },
275
- {
276
- name: 'Check Existence in Store By Query',
277
- value: 'headInStoreByQuery',
278
- action: 'Check if any customer matches the query in store',
279
- description: 'Send a HEAD request with query predicates in a specific store',
280
- },
281
- {
282
- name: 'Create (Sign Up)',
283
- value: 'create',
284
- action: 'Create customer',
285
- description: 'Create a new customer (sign up)',
286
- },
287
- {
288
- name: 'Create Email Token',
289
- value: 'createEmailToken',
290
- action: 'Create email verification token',
291
- description: 'Create an email verification token for a customer',
292
- },
293
- {
294
- name: 'Create Email Token in Store',
295
- value: 'createEmailTokenInStore',
296
- action: 'Create email verification token in store',
297
- description: 'Create an email verification token for a customer in a specific store',
298
- },
299
- {
300
- name: 'Create in Store (Sign Up)',
301
- value: 'createInStore',
302
- action: 'Create customer in store',
303
- description: 'Create a new customer in a specific store',
304
- },
305
- {
306
- name: 'Create Password Reset Token',
307
- value: 'createPasswordResetToken',
308
- action: 'Create password reset token',
309
- description: 'Create a password reset token for a customer',
310
- },
311
- {
312
- name: 'Create Password Reset Token in Store',
313
- value: 'createPasswordResetTokenInStore',
314
- action: 'Create password reset token in store',
315
- description: 'Create a password reset token for a customer in a specific store',
316
- },
317
- {
318
- name: 'Delete',
319
- value: 'delete',
320
- action: 'Delete customer',
321
- description: 'Delete a customer by ID',
322
- },
323
- {
324
- name: 'Delete By Key',
325
- value: 'deleteByKey',
326
- action: 'Delete customer by key',
327
- description: 'Delete a customer using its key',
328
- },
329
- {
330
- name: 'Delete in Store',
331
- value: 'deleteInStore',
332
- action: 'Delete customer in store',
333
- description: 'Delete a customer by ID in a specific store',
334
- },
335
- {
336
- name: 'Delete in Store By Key',
337
- value: 'deleteInStoreByKey',
338
- action: 'Delete customer in store by key',
339
- description: 'Delete a customer by key in a specific store',
340
- },
341
- {
342
- name: 'Get',
343
- value: 'get',
344
- action: 'Get customer',
345
- description: 'Retrieve a customer by ID',
346
- },
347
- {
348
- name: 'Get By Email Token',
349
- value: 'getByEmailToken',
350
- action: 'Get customer by email token',
351
- description: 'Retrieve a customer using an email verification token',
352
- },
353
- {
354
- name: 'Get By Key',
355
- value: 'getByKey',
356
- action: 'Get customer by key',
357
- description: 'Retrieve a customer using its key',
358
- },
359
- {
360
- name: 'Get By Password Token',
361
- value: 'getByPasswordToken',
362
- action: 'Get customer by password token',
363
- description: 'Retrieve a customer using a password reset token',
364
- },
365
- {
366
- name: 'Get in Store',
367
- value: 'getInStore',
368
- action: 'Get customer in store',
369
- description: 'Retrieve a customer by ID in a specific store',
370
- },
371
- {
372
- name: 'Get in Store By Email Token',
373
- value: 'getInStoreByEmailToken',
374
- action: 'Get customer in store by email token',
375
- description: 'Retrieve a customer by email token in a specific store',
376
- },
377
- {
378
- name: 'Get in Store By Key',
379
- value: 'getInStoreByKey',
380
- action: 'Get customer in store by key',
381
- description: 'Retrieve a customer by key in a specific store',
382
- },
383
- {
384
- name: 'Get in Store By Password Token',
385
- value: 'getInStoreByPasswordToken',
386
- action: 'Get customer in store by password token',
387
- description: 'Retrieve a customer by password token in a specific store',
388
- },
389
- {
390
- name: 'Query',
391
- value: 'query',
392
- action: 'Query customers',
393
- description: 'List customers using query parameters',
394
- },
395
- {
396
- name: 'Query in Store',
397
- value: 'queryInStore',
398
- action: 'Query customers in store',
399
- description: 'List customers in a specific store using query parameters',
400
- },
401
- {
402
- name: 'Reset Password',
403
- value: 'resetPassword',
404
- action: 'Reset customer password',
405
- description: 'Reset password of a customer using a reset token',
406
- },
407
- {
408
- name: 'Reset Password in Store',
409
- value: 'resetPasswordInStore',
410
- action: 'Reset customer password in store',
411
- description: 'Reset password of a customer in a specific store using a reset token',
412
- },
413
- {
414
- name: 'Update',
415
- value: 'update',
416
- action: 'Update customer',
417
- description: 'Perform update actions on a customer by ID',
418
- },
419
- {
420
- name: 'Update By Key',
421
- value: 'updateByKey',
422
- action: 'Update customer by key',
423
- description: 'Perform update actions on a customer by key',
424
- },
425
- {
426
- name: 'Update in Store',
427
- value: 'updateInStore',
428
- action: 'Update customer in store',
429
- description: 'Perform update actions on a customer by ID in a specific store',
430
- },
431
- {
432
- name: 'Update in Store By Key',
433
- value: 'updateInStoreByKey',
434
- action: 'Update customer in store by key',
435
- description: 'Perform update actions on a customer by key in a specific store',
436
- },
437
- {
438
- name: 'Verify Email',
439
- value: 'verifyEmail',
440
- action: 'Verify customer email',
441
- description: 'Verify email address of a customer using a verification token',
442
- },
443
- {
444
- name: 'Verify Email in Store',
445
- value: 'verifyEmailInStore',
446
- action: 'Verify customer email in store',
447
- description: 'Verify email address of a customer in a specific store',
448
- },
449
- ],
450
- default: 'query',
451
- displayOptions: {
452
- show: {
453
- resource: ['customer'],
454
- },
455
- },
456
- },
457
- {
458
- displayName: 'Product ID',
459
- name: 'productId',
460
- type: 'string',
461
- default: '',
462
- required: true,
463
- displayOptions: {
464
- show: {
465
- resource: ['product'],
466
- operation: ['get', 'update', 'delete', 'head', 'querySelections', 'uploadImage'],
467
- },
468
- },
469
- description: 'Unique ID of the product to target',
470
- },
471
- {
472
- displayName: 'Product Key',
473
- name: 'productKey',
474
- type: 'string',
475
- default: '',
476
- required: true,
477
- displayOptions: {
478
- show: {
479
- resource: ['product'],
480
- operation: ['getByKey', 'updateByKey', 'deleteByKey', 'headByKey', 'querySelectionsByKey'],
481
- },
482
- },
483
- description: 'Unique key of the product to target',
484
- },
485
- {
486
- displayName: 'Category ID',
487
- name: 'categoryId',
488
- type: 'string',
489
- default: '',
490
- required: true,
491
- displayOptions: {
492
- show: {
493
- resource: ['category'],
494
- operation: ['get', 'update', 'delete'],
495
- },
496
- },
497
- description: 'Unique ID of the category to target',
498
- },
499
- {
500
- displayName: 'Category Key',
501
- name: 'categoryKey',
502
- type: 'string',
503
- default: '',
504
- required: true,
505
- displayOptions: {
506
- show: {
507
- resource: ['category'],
508
- operation: ['getByKey', 'updateByKey', 'deleteByKey'],
509
- },
510
- },
511
- description: 'Unique key of the category to target',
512
- },
513
- {
514
- displayName: 'Category Draft (JSON)',
515
- name: 'categoryDraft',
516
- type: 'json',
517
- default: '{}',
518
- required: true,
519
- displayOptions: {
520
- show: {
521
- resource: ['category'],
522
- operation: ['create'],
523
- },
524
- },
525
- description: 'JSON representation of the category draft to create, e.g. <code>{"name":{"en":"Accessories"},"slug":{"en":"accessories"}}</code>',
526
- },
527
- {
528
- displayName: 'Product Draft (JSON)',
529
- name: 'productDraft',
530
- type: 'json',
531
- default: '{}',
532
- required: true,
533
- displayOptions: {
534
- show: {
535
- resource: ['product'],
536
- operation: ['create'],
537
- },
538
- },
539
- description: 'JSON representation of the product draft to create, e.g. <code>{"productType":{"typeId":"product-type","ID":"..."},"name":{"en":"Product"},"slug":{"en":"product"}}</code>',
540
- },
541
- {
542
- displayName: 'Version',
543
- name: 'version',
544
- type: 'number',
545
- typeOptions: {
546
- minValue: 0,
547
- },
548
- default: 0,
549
- required: true,
550
- displayOptions: {
551
- show: {
552
- resource: ['product', 'category'],
553
- operation: ['update', 'updateByKey', 'delete', 'deleteByKey'],
554
- },
555
- },
556
- description: 'Current version of the resource to ensure optimistic concurrency control',
557
- },
558
- {
559
- displayName: 'Actions (JSON)',
560
- name: 'actions',
561
- type: 'json',
562
- default: '[]',
563
- description: 'Update actions to apply to the resource',
564
- displayOptions: {
565
- show: {
566
- resource: ['product', 'category'],
567
- operation: ['update', 'updateByKey'],
568
- },
569
- },
570
- },
571
- {
572
- displayName: 'Actions (UI)',
573
- name: 'actionsUi',
574
- type: 'fixedCollection',
575
- default: {},
576
- placeholder: 'Add Action',
577
- typeOptions: {
578
- multipleValues: true,
579
- },
580
- description: 'Update actions built via UI for ease of use',
581
- options: [
582
- {
583
- displayName: 'Action',
584
- name: 'action',
585
- values: [
586
- {
587
- displayName: 'Change Product Name',
588
- name: 'changeProductName',
589
- type: 'collection',
590
- default: {},
591
- placeholder: 'Add Change Name Action',
592
- options: [
593
- {
594
- displayName: 'Localized Names',
595
- name: 'localizedNames',
596
- type: 'fixedCollection',
597
- default: {},
598
- typeOptions: {
599
- multipleValues: true,
600
- },
601
- options: [
602
- {
603
- name: 'value',
604
- displayName: 'Value',
605
- values: [
606
- {
607
- displayName: 'Locale',
608
- name: 'locale',
609
- type: 'string',
610
- default: '',
611
- description: 'Locale identifier, e.g. "en-US"',
612
- },
613
- {
614
- displayName: 'Name',
615
- name: 'value',
616
- type: 'string',
617
- default: '',
618
- description: 'Localized product name for the locale',
619
- },
620
- ],
621
- },
622
- ],
623
- },
624
- {
625
- displayName: 'Apply to Staged Version',
626
- name: 'staged',
627
- type: 'boolean',
628
- default: false,
629
- description: 'Whether the name change should apply to the staged product data',
630
- },
631
- ],
632
- },
633
- {
634
- displayName: 'Set Product Key',
635
- name: 'setProductKey',
636
- type: 'collection',
637
- default: {},
638
- placeholder: 'Add Set Product Key Action',
639
- options: [
640
- {
641
- displayName: 'New Key',
642
- name: 'key',
643
- type: 'string',
644
- default: '',
645
- description: 'New product key to set',
646
- },
647
- {
648
- displayName: 'Remove Key',
649
- name: 'removeKey',
650
- type: 'boolean',
651
- default: false,
652
- description: 'Whether to remove the product key instead of setting a new one',
653
- },
654
- ],
655
- },
656
- ],
657
- },
658
- ],
659
- displayOptions: {
660
- show: {
661
- resource: ['product'],
662
- operation: ['update', 'updateByKey'],
663
- },
664
- },
665
- },
666
- {
667
- displayName: 'Additional Fields',
668
- name: 'additionalFields',
669
- type: 'collection',
670
- default: {},
671
- placeholder: 'Add Field',
672
- options: [
673
- {
674
- displayName: 'Custom Query Parameters',
675
- name: 'customParameters',
676
- type: 'fixedCollection',
677
- default: {},
678
- placeholder: 'Add Parameter',
679
- typeOptions: {
680
- multipleValues: true,
681
- },
682
- options: [
683
- {
684
- name: 'parameter',
685
- displayName: 'Parameter',
686
- values: [
687
- {
688
- displayName: 'Key',
689
- name: 'key',
690
- type: 'string',
691
- default: '',
692
- },
693
- {
694
- displayName: 'Value',
695
- name: 'value',
696
- type: 'string',
697
- default: '',
698
- },
699
- ],
700
- },
701
- ],
702
- },
703
- {
704
- displayName: 'Expand',
705
- name: 'expand',
706
- type: 'string',
707
- default: '',
708
- description: 'Include additional resources by reference expansion',
709
- },
710
- {
711
- displayName: 'Locale Projection',
712
- name: 'localeProjection',
713
- type: 'string',
714
- default: '',
715
- description: 'Select locales for returned localized fields',
716
- },
717
- {
718
- displayName: 'Predicate Variables',
719
- name: 'predicateVariables',
720
- type: 'fixedCollection',
721
- default: {},
722
- placeholder: 'Add Predicate Variable',
723
- typeOptions: {
724
- multipleValues: true,
725
- },
726
- options: [
727
- {
728
- name: 'variable',
729
- displayName: 'Variable',
730
- values: [
731
- {
732
- displayName: 'Name',
733
- name: 'name',
734
- type: 'string',
735
- default: '',
736
- },
737
- {
738
- displayName: 'Value',
739
- name: 'value',
740
- type: 'string',
741
- default: '',
742
- },
743
- ],
744
- },
745
- ],
746
- },
747
- {
748
- displayName: 'Price Channel',
749
- name: 'priceChannel',
750
- type: 'string',
751
- default: '',
752
- description: 'Channel to select prices for',
753
- },
754
- {
755
- displayName: 'Price Country',
756
- name: 'priceCountry',
757
- type: 'string',
758
- default: '',
759
- description: 'Country to select prices for',
760
- },
761
- {
762
- displayName: 'Price Currency',
763
- name: 'priceCurrency',
764
- type: 'string',
765
- default: '',
766
- description: 'Currency code for price selection',
767
- },
768
- {
769
- displayName: 'Price Customer Group',
770
- name: 'priceCustomerGroup',
771
- type: 'string',
772
- default: '',
773
- description: 'Customer group to select prices for',
774
- },
775
- {
776
- displayName: 'Sort',
777
- name: 'sort',
778
- type: 'string',
779
- default: '',
780
- description: 'Sorting expression for query results, e.g. <code>createdAt desc</code>',
781
- },
782
- {
783
- displayName: 'Staged',
784
- name: 'staged',
785
- type: 'boolean',
786
- default: false,
787
- description: 'Whether to retrieve the staged projection',
788
- },
789
- {
790
- displayName: 'Store Projection',
791
- name: 'storeProjection',
792
- type: 'string',
793
- default: '',
794
- description: 'Store in which the results are projected',
795
- },
796
- {
797
- displayName: 'Where',
798
- name: 'where',
799
- type: 'string',
800
- default: '',
801
- description: 'Query predicates to filter results',
802
- },
803
- {
804
- displayName: 'With Total',
805
- name: 'withTotal',
806
- type: 'boolean',
807
- default: true,
808
- description: 'Whether the query should calculate the total number of matching products',
809
- },
810
- ],
811
- displayOptions: {
812
- show: {
813
- resource: ['product'],
814
- operation: ['query'],
815
- },
816
- },
817
- },
818
- {
819
- displayName: 'Return All',
820
- name: 'returnAll',
821
- type: 'boolean',
822
- default: false,
823
- displayOptions: {
824
- show: {
825
- resource: ['product'],
826
- operation: ['query'],
827
- },
828
- },
829
- description: 'Whether to return all results or only up to a given limit',
830
- },
831
- {
832
- displayName: 'Limit',
833
- name: 'limit',
834
- type: 'number',
835
- default: 50,
836
- typeOptions: {
837
- minValue: 1,
838
- maxValue: 500,
839
- },
840
- displayOptions: {
841
- show: {
842
- resource: ['product'],
843
- operation: ['query'],
844
- returnAll: [false],
845
- },
846
- },
847
- description: 'Max number of results to return',
848
- },
849
- {
850
- displayName: 'Offset',
851
- name: 'offset',
852
- type: 'number',
853
- default: 0,
854
- typeOptions: {
855
- minValue: 0,
856
- },
857
- displayOptions: {
858
- show: {
859
- resource: ['product'],
860
- operation: ['query'],
861
- },
862
- },
863
- description: 'Number of products to skip before returning results',
864
- },
865
- {
866
- displayName: 'Additional Fields',
867
- name: 'additionalFieldsGet',
868
- type: 'collection',
869
- default: {},
870
- placeholder: 'Add Field',
871
- options: [
872
- {
873
- displayName: 'Custom Query Parameters',
874
- name: 'customParameters',
875
- type: 'fixedCollection',
876
- default: {},
877
- placeholder: 'Add Parameter',
878
- typeOptions: {
879
- multipleValues: true,
880
- },
881
- options: [
882
- {
883
- name: 'parameter',
884
- displayName: 'Parameter',
885
- values: [
886
- {
887
- displayName: 'Key',
888
- name: 'key',
889
- type: 'string',
890
- default: '',
891
- },
892
- {
893
- displayName: 'Value',
894
- name: 'value',
895
- type: 'string',
896
- default: '',
897
- },
898
- ],
899
- },
900
- ],
901
- },
902
- {
903
- displayName: 'Expand',
904
- name: 'expand',
905
- type: 'string',
906
- default: '',
907
- description: 'Include additional resources by reference expansion',
908
- },
909
- {
910
- displayName: 'Locale Projection',
911
- name: 'localeProjection',
912
- type: 'string',
913
- default: '',
914
- description: 'Select locales for returned localized fields',
915
- },
916
- {
917
- displayName: 'Price Channel',
918
- name: 'priceChannel',
919
- type: 'string',
920
- default: '',
921
- description: 'Channel to select prices for',
922
- },
923
- {
924
- displayName: 'Price Country',
925
- name: 'priceCountry',
926
- type: 'string',
927
- default: '',
928
- description: 'Country to select prices for',
929
- },
930
- {
931
- displayName: 'Price Currency',
932
- name: 'priceCurrency',
933
- type: 'string',
934
- default: '',
935
- description: 'Currency code for price selection',
936
- },
937
- {
938
- displayName: 'Price Customer Group',
939
- name: 'priceCustomerGroup',
940
- type: 'string',
941
- default: '',
942
- description: 'Customer group to select prices for',
943
- },
944
- {
945
- displayName: 'Staged',
946
- name: 'staged',
947
- type: 'boolean',
948
- default: false,
949
- description: 'Whether to retrieve the staged projection',
950
- },
951
- {
952
- displayName: 'Store Projection',
953
- name: 'storeProjection',
954
- type: 'string',
955
- default: '',
956
- description: 'Store in which the results are projected',
957
- },
958
- ],
959
- displayOptions: {
960
- show: {
961
- resource: ['product'],
962
- operation: ['get', 'getByKey'],
963
- },
964
- },
965
- },
966
- {
967
- displayName: 'Additional Fields',
968
- name: 'additionalFieldsSearch',
969
- type: 'collection',
970
- default: {},
971
- placeholder: 'Add Field',
972
- options: [
973
- {
974
- displayName: 'Custom Query Parameters',
975
- name: 'customParameters',
976
- type: 'fixedCollection',
977
- default: {},
978
- placeholder: 'Add Parameter',
979
- typeOptions: {
980
- multipleValues: true,
981
- },
982
- options: [
983
- {
984
- name: 'parameter',
985
- displayName: 'Parameter',
986
- values: [
987
- {
988
- displayName: 'Key',
989
- name: 'key',
990
- type: 'string',
991
- default: '',
992
- },
993
- {
994
- displayName: 'Value',
995
- name: 'value',
996
- type: 'string',
997
- default: '',
998
- },
999
- ],
1000
- },
1001
- ],
1002
- },
1003
- {
1004
- displayName: 'Expand',
1005
- name: 'expand',
1006
- type: 'string',
1007
- default: '',
1008
- description: 'Include additional resources by reference expansion',
1009
- },
1010
- {
1011
- displayName: 'Locale Projection',
1012
- name: 'localeProjection',
1013
- type: 'string',
1014
- default: '',
1015
- description: 'Select locales for returned localized fields',
1016
- },
1017
- {
1018
- displayName: 'Mark Matching Variants',
1019
- name: 'markMatchingVariants',
1020
- type: 'boolean',
1021
- default: false,
1022
- description: 'Whether to mark matching variants in search results',
1023
- },
1024
- {
1025
- displayName: 'Price Channel',
1026
- name: 'priceChannel',
1027
- type: 'string',
1028
- default: '',
1029
- description: 'Channel to select prices for',
1030
- },
1031
- {
1032
- displayName: 'Price Country',
1033
- name: 'priceCountry',
1034
- type: 'string',
1035
- default: '',
1036
- description: 'Country to select prices for',
1037
- },
1038
- {
1039
- displayName: 'Price Currency',
1040
- name: 'priceCurrency',
1041
- type: 'string',
1042
- default: '',
1043
- description: 'Currency code for price selection',
1044
- },
1045
- {
1046
- displayName: 'Price Customer Group',
1047
- name: 'priceCustomerGroup',
1048
- type: 'string',
1049
- default: '',
1050
- description: 'Customer group to select prices for',
1051
- },
1052
- {
1053
- displayName: 'Staged',
1054
- name: 'staged',
1055
- type: 'boolean',
1056
- default: false,
1057
- description: 'Whether to retrieve the staged projection',
1058
- },
1059
- {
1060
- displayName: 'Store Projection',
1061
- name: 'storeProjection',
1062
- type: 'string',
1063
- default: '',
1064
- description: 'Store in which the results are projected',
1065
- },
1066
- {
1067
- displayName: 'With Total',
1068
- name: 'withTotal',
1069
- type: 'boolean',
1070
- default: true,
1071
- description: 'Whether the search should calculate the total number of matching products',
1072
- },
1073
- ],
1074
- displayOptions: {
1075
- show: {
1076
- resource: ['product'],
1077
- operation: ['search'],
1078
- },
1079
- },
1080
- },
1081
- {
1082
- displayName: 'Additional Fields',
1083
- name: 'additionalFieldsCreate',
1084
- type: 'collection',
1085
- default: {},
1086
- placeholder: 'Add Field',
1087
- options: [
1088
- {
1089
- displayName: 'Custom Query Parameters',
1090
- name: 'customParameters',
1091
- type: 'fixedCollection',
1092
- default: {},
1093
- placeholder: 'Add Parameter',
1094
- typeOptions: {
1095
- multipleValues: true,
1096
- },
1097
- options: [
1098
- {
1099
- name: 'parameter',
1100
- displayName: 'Parameter',
1101
- values: [
1102
- {
1103
- displayName: 'Key',
1104
- name: 'key',
1105
- type: 'string',
1106
- default: '',
1107
- },
1108
- {
1109
- displayName: 'Value',
1110
- name: 'value',
1111
- type: 'string',
1112
- default: '',
1113
- },
1114
- ],
1115
- },
1116
- ],
1117
- },
1118
- {
1119
- displayName: 'Expand',
1120
- name: 'expand',
1121
- type: 'string',
1122
- default: '',
1123
- description: 'Include additional resources by reference expansion',
1124
- },
1125
- {
1126
- displayName: 'Locale Projection',
1127
- name: 'localeProjection',
1128
- type: 'string',
1129
- default: '',
1130
- description: 'Select locales for returned localized fields',
1131
- },
1132
- {
1133
- displayName: 'Price Channel',
1134
- name: 'priceChannel',
1135
- type: 'string',
1136
- default: '',
1137
- description: 'Channel to select prices for',
1138
- },
1139
- {
1140
- displayName: 'Price Country',
1141
- name: 'priceCountry',
1142
- type: 'string',
1143
- default: '',
1144
- description: 'Country to select prices for',
1145
- },
1146
- {
1147
- displayName: 'Price Currency',
1148
- name: 'priceCurrency',
1149
- type: 'string',
1150
- default: '',
1151
- description: 'Currency code for price selection',
1152
- },
1153
- {
1154
- displayName: 'Price Customer Group',
1155
- name: 'priceCustomerGroup',
1156
- type: 'string',
1157
- default: '',
1158
- description: 'Customer group to select prices for',
1159
- },
1160
- {
1161
- displayName: 'Staged',
1162
- name: 'staged',
1163
- type: 'boolean',
1164
- default: true,
1165
- description: 'Whether to create the product in the staged state',
1166
- },
1167
- {
1168
- displayName: 'Store Projection',
1169
- name: 'storeProjection',
1170
- type: 'string',
1171
- default: '',
1172
- description: 'Store in which the results are projected',
1173
- },
1174
- ],
1175
- displayOptions: {
1176
- show: {
1177
- resource: ['product'],
1178
- operation: ['create'],
1179
- },
1180
- },
1181
- },
1182
- {
1183
- displayName: 'Additional Fields',
1184
- name: 'additionalFieldsUpdate',
1185
- type: 'collection',
1186
- default: {},
1187
- placeholder: 'Add Field',
1188
- options: [
1189
- {
1190
- displayName: 'Custom Query Parameters',
1191
- name: 'customParameters',
1192
- type: 'fixedCollection',
1193
- default: {},
1194
- placeholder: 'Add Parameter',
1195
- typeOptions: {
1196
- multipleValues: true,
1197
- },
1198
- options: [
1199
- {
1200
- name: 'parameter',
1201
- displayName: 'Parameter',
1202
- values: [
1203
- {
1204
- displayName: 'Key',
1205
- name: 'key',
1206
- type: 'string',
1207
- default: '',
1208
- },
1209
- {
1210
- displayName: 'Value',
1211
- name: 'value',
1212
- type: 'string',
1213
- default: '',
1214
- },
1215
- ],
1216
- },
1217
- ],
1218
- },
1219
- {
1220
- displayName: 'Data Erasure',
1221
- name: 'dataErasure',
1222
- type: 'boolean',
1223
- default: false,
1224
- description: 'Whether to irreversibly delete personal data',
1225
- },
1226
- {
1227
- displayName: 'Dry Run',
1228
- name: 'dryRun',
1229
- type: 'boolean',
1230
- default: false,
1231
- description: 'Whether to simulate the update without persisting changes',
1232
- },
1233
- {
1234
- displayName: 'Expand',
1235
- name: 'expand',
1236
- type: 'string',
1237
- default: '',
1238
- description: 'Include additional resources by reference expansion',
1239
- },
1240
- {
1241
- displayName: 'Locale Projection',
1242
- name: 'localeProjection',
1243
- type: 'string',
1244
- default: '',
1245
- description: 'Select locales for returned localized fields',
1246
- },
1247
- {
1248
- displayName: 'Predicate Variables',
1249
- name: 'predicateVariables',
1250
- type: 'fixedCollection',
1251
- default: {},
1252
- placeholder: 'Add Predicate Variable',
1253
- typeOptions: {
1254
- multipleValues: true,
1255
- },
1256
- options: [
1257
- {
1258
- name: 'variable',
1259
- displayName: 'Variable',
1260
- values: [
1261
- {
1262
- displayName: 'Name',
1263
- name: 'name',
1264
- type: 'string',
1265
- default: '',
1266
- },
1267
- {
1268
- displayName: 'Value',
1269
- name: 'value',
1270
- type: 'string',
1271
- default: '',
1272
- },
1273
- ],
1274
- },
1275
- ],
1276
- },
1277
- {
1278
- displayName: 'Price Channel',
1279
- name: 'priceChannel',
1280
- type: 'string',
1281
- default: '',
1282
- description: 'Channel to select prices for',
1283
- },
1284
- {
1285
- displayName: 'Price Country',
1286
- name: 'priceCountry',
1287
- type: 'string',
1288
- default: '',
1289
- description: 'Country to select prices for',
1290
- },
1291
- {
1292
- displayName: 'Price Currency',
1293
- name: 'priceCurrency',
1294
- type: 'string',
1295
- default: '',
1296
- description: 'Currency code for price selection',
1297
- },
1298
- {
1299
- displayName: 'Price Customer Group',
1300
- name: 'priceCustomerGroup',
1301
- type: 'string',
1302
- default: '',
1303
- description: 'Customer group to select prices for',
1304
- },
1305
- {
1306
- displayName: 'Staged',
1307
- name: 'staged',
1308
- type: 'boolean',
1309
- default: false,
1310
- description: 'Whether the update should affect the staged product data',
1311
- },
1312
- {
1313
- displayName: 'Store Projection',
1314
- name: 'storeProjection',
1315
- type: 'string',
1316
- default: '',
1317
- description: 'Store in which the results are projected',
1318
- },
1319
- ],
1320
- displayOptions: {
1321
- show: {
1322
- resource: ['product'],
1323
- operation: ['update', 'updateByKey'],
1324
- },
1325
- },
1326
- },
1327
- {
1328
- displayName: 'Additional Fields',
1329
- name: 'additionalFieldsDelete',
1330
- type: 'collection',
1331
- default: {},
1332
- placeholder: 'Add Field',
1333
- options: [
1334
- {
1335
- displayName: 'Custom Query Parameters',
1336
- name: 'customParameters',
1337
- type: 'fixedCollection',
1338
- default: {},
1339
- placeholder: 'Add Parameter',
1340
- typeOptions: {
1341
- multipleValues: true,
1342
- },
1343
- options: [
1344
- {
1345
- name: 'parameter',
1346
- displayName: 'Parameter',
1347
- values: [
1348
- {
1349
- displayName: 'Key',
1350
- name: 'key',
1351
- type: 'string',
1352
- default: '',
1353
- },
1354
- {
1355
- displayName: 'Value',
1356
- name: 'value',
1357
- type: 'string',
1358
- default: '',
1359
- },
1360
- ],
1361
- },
1362
- ],
1363
- },
1364
- {
1365
- displayName: 'Data Erasure',
1366
- name: 'dataErasure',
1367
- type: 'boolean',
1368
- default: false,
1369
- description: 'Whether to irreversibly delete personal data',
1370
- },
1371
- {
1372
- displayName: 'Expand',
1373
- name: 'expand',
1374
- type: 'string',
1375
- default: '',
1376
- description: 'Include additional resources by reference expansion',
1377
- },
1378
- {
1379
- displayName: 'Locale Projection',
1380
- name: 'localeProjection',
1381
- type: 'string',
1382
- default: '',
1383
- description: 'Select locales for returned localized fields',
1384
- },
1385
- {
1386
- displayName: 'Price Channel',
1387
- name: 'priceChannel',
1388
- type: 'string',
1389
- default: '',
1390
- description: 'Channel to select prices for',
1391
- },
1392
- {
1393
- displayName: 'Price Country',
1394
- name: 'priceCountry',
1395
- type: 'string',
1396
- default: '',
1397
- description: 'Country to select prices for',
1398
- },
1399
- {
1400
- displayName: 'Price Currency',
1401
- name: 'priceCurrency',
1402
- type: 'string',
1403
- default: '',
1404
- description: 'Currency code for price selection',
1405
- },
1406
- {
1407
- displayName: 'Price Customer Group',
1408
- name: 'priceCustomerGroup',
1409
- type: 'string',
1410
- default: '',
1411
- description: 'Customer group to select prices for',
1412
- },
1413
- {
1414
- displayName: 'Staged',
1415
- name: 'staged',
1416
- type: 'boolean',
1417
- default: false,
1418
- description: 'Whether to delete the staged projection',
1419
- },
1420
- ],
1421
- displayOptions: {
1422
- show: {
1423
- resource: ['product'],
1424
- operation: ['delete', 'deleteByKey'],
1425
- },
1426
- },
1427
- },
1428
- {
1429
- displayName: 'Additional Fields',
1430
- name: 'additionalFieldsHead',
1431
- type: 'collection',
1432
- default: {},
1433
- placeholder: 'Add Field',
1434
- options: [
1435
- {
1436
- displayName: 'Custom Query Parameters',
1437
- name: 'customParameters',
1438
- type: 'fixedCollection',
1439
- default: {},
1440
- placeholder: 'Add Parameter',
1441
- typeOptions: {
1442
- multipleValues: true,
1443
- },
1444
- options: [
1445
- {
1446
- name: 'parameter',
1447
- displayName: 'Parameter',
1448
- values: [
1449
- {
1450
- displayName: 'Key',
1451
- name: 'key',
1452
- type: 'string',
1453
- default: '',
1454
- },
1455
- {
1456
- displayName: 'Value',
1457
- name: 'value',
1458
- type: 'string',
1459
- default: '',
1460
- },
1461
- ],
1462
- },
1463
- ],
1464
- },
1465
- {
1466
- displayName: 'Expand',
1467
- name: 'expand',
1468
- type: 'string',
1469
- default: '',
1470
- description: 'Include additional resources by reference expansion',
1471
- },
1472
- {
1473
- displayName: 'Locale Projection',
1474
- name: 'localeProjection',
1475
- type: 'string',
1476
- default: '',
1477
- description: 'Select locales for returned localized fields',
1478
- },
1479
- {
1480
- displayName: 'Price Channel',
1481
- name: 'priceChannel',
1482
- type: 'string',
1483
- default: '',
1484
- description: 'Channel to select prices for',
1485
- },
1486
- {
1487
- displayName: 'Price Country',
1488
- name: 'priceCountry',
1489
- type: 'string',
1490
- default: '',
1491
- description: 'Country to select prices for',
1492
- },
1493
- {
1494
- displayName: 'Price Currency',
1495
- name: 'priceCurrency',
1496
- type: 'string',
1497
- default: '',
1498
- description: 'Currency code for price selection',
1499
- },
1500
- {
1501
- displayName: 'Price Customer Group',
1502
- name: 'priceCustomerGroup',
1503
- type: 'string',
1504
- default: '',
1505
- description: 'Customer group to select prices for',
1506
- },
1507
- {
1508
- displayName: 'Staged',
1509
- name: 'staged',
1510
- type: 'boolean',
1511
- default: false,
1512
- description: 'Whether to inspect the staged projection',
1513
- },
1514
- {
1515
- displayName: 'Store Projection',
1516
- name: 'storeProjection',
1517
- type: 'string',
1518
- default: '',
1519
- description: 'Store in which the results are projected',
1520
- },
1521
- ],
1522
- displayOptions: {
1523
- show: {
1524
- resource: ['product'],
1525
- operation: ['head', 'headByKey'],
1526
- },
1527
- },
1528
- },
1529
- {
1530
- displayName: 'Additional Fields',
1531
- name: 'additionalFieldsSelections',
1532
- type: 'collection',
1533
- default: {},
1534
- placeholder: 'Add Field',
1535
- options: [
1536
- {
1537
- displayName: 'Custom Query Parameters',
1538
- name: 'customParameters',
1539
- type: 'fixedCollection',
1540
- default: {},
1541
- placeholder: 'Add Parameter',
1542
- typeOptions: {
1543
- multipleValues: true,
1544
- },
1545
- options: [
1546
- {
1547
- name: 'parameter',
1548
- displayName: 'Parameter',
1549
- values: [
1550
- {
1551
- displayName: 'Key',
1552
- name: 'key',
1553
- type: 'string',
1554
- default: '',
1555
- },
1556
- {
1557
- displayName: 'Value',
1558
- name: 'value',
1559
- type: 'string',
1560
- default: '',
1561
- },
1562
- ],
1563
- },
1564
- ],
1565
- },
1566
- {
1567
- displayName: 'Expand',
1568
- name: 'expand',
1569
- type: 'string',
1570
- default: '',
1571
- description: 'Include additional resources by reference expansion',
1572
- },
1573
- {
1574
- displayName: 'Limit',
1575
- name: 'limit',
1576
- type: 'number',
1577
- default: 50,
1578
- typeOptions: {
1579
- minValue: 1,
1580
- maxValue: 500,
1581
- },
1582
- description: 'Max number of results to return',
1583
- },
1584
- {
1585
- displayName: 'Offset',
1586
- name: 'offset',
1587
- type: 'number',
1588
- default: 0,
1589
- typeOptions: {
1590
- minValue: 0,
1591
- },
1592
- description: 'Number of product selections to skip before returning results',
1593
- },
1594
- {
1595
- displayName: 'With Total',
1596
- name: 'withTotal',
1597
- type: 'boolean',
1598
- default: true,
1599
- description: 'Whether the query should calculate the total number of matching product selections',
1600
- },
1601
- ],
1602
- displayOptions: {
1603
- show: {
1604
- resource: ['product'],
1605
- operation: ['querySelections', 'querySelectionsByKey'],
1606
- },
1607
- },
1608
- },
1609
- {
1610
- displayName: 'Search Request (JSON)',
1611
- name: 'searchRequest',
1612
- type: 'json',
1613
- default: '{}',
1614
- displayOptions: {
1615
- show: {
1616
- resource: ['product'],
1617
- operation: ['search'],
1618
- },
1619
- },
1620
- description: 'Search request body for the Product Search endpoint',
1621
- },
1622
- {
1623
- displayName: 'Additional Fields',
1624
- name: 'additionalFieldsUpload',
1625
- type: 'collection',
1626
- default: {},
1627
- placeholder: 'Add Field',
1628
- options: [
1629
- {
1630
- displayName: 'Custom Query Parameters',
1631
- name: 'customParameters',
1632
- type: 'fixedCollection',
1633
- default: {},
1634
- placeholder: 'Add Parameter',
1635
- typeOptions: {
1636
- multipleValues: true,
1637
- },
1638
- options: [
1639
- {
1640
- name: 'parameter',
1641
- displayName: 'Parameter',
1642
- values: [
1643
- {
1644
- displayName: 'Key',
1645
- name: 'key',
1646
- type: 'string',
1647
- default: '',
1648
- },
1649
- {
1650
- displayName: 'Value',
1651
- name: 'value',
1652
- type: 'string',
1653
- default: '',
1654
- },
1655
- ],
1656
- },
1657
- ],
1658
- },
1659
- {
1660
- displayName: 'External URL',
1661
- name: 'externalUrl',
1662
- type: 'string',
1663
- default: '',
1664
- description: 'If set, treats the image as an external URL instead of uploading binary content',
1665
- },
1666
- {
1667
- displayName: 'Filename',
1668
- name: 'filename',
1669
- type: 'string',
1670
- default: '',
1671
- description: 'Filename to store with the uploaded image',
1672
- },
1673
- {
1674
- displayName: 'Label',
1675
- name: 'label',
1676
- type: 'string',
1677
- default: '',
1678
- description: 'Localized label for the image, e.g. <code>{"en":"Front"}</code>',
1679
- },
1680
- {
1681
- displayName: 'SKU',
1682
- name: 'sku',
1683
- type: 'string',
1684
- default: '',
1685
- description: 'SKU the image belongs to',
1686
- },
1687
- {
1688
- displayName: 'Staged',
1689
- name: 'staged',
1690
- type: 'boolean',
1691
- default: true,
1692
- description: 'Whether to add the image to the staged version',
1693
- },
1694
- {
1695
- displayName: 'Variant ID',
1696
- name: 'variantId',
1697
- type: 'number',
1698
- typeOptions: {
1699
- minValue: 0,
1700
- },
1701
- default: 0,
1702
- description: 'Variant ID the image belongs to',
1703
- },
1704
- ],
1705
- displayOptions: {
1706
- show: {
1707
- resource: ['product'],
1708
- operation: ['uploadImage'],
1709
- },
1710
- },
1711
- },
1712
- {
1713
- displayName: 'Binary Property',
1714
- name: 'binaryPropertyName',
1715
- type: 'string',
1716
- default: 'data',
1717
- required: true,
1718
- displayOptions: {
1719
- show: {
1720
- resource: ['product'],
1721
- operation: ['uploadImage'],
1722
- },
1723
- },
1724
- description: 'Name of the binary property in the incoming item that contains the image',
1725
- },
1726
- {
1727
- displayName: 'Additional Fields',
1728
- name: 'categoryAdditionalFieldsQuery',
1729
- type: 'collection',
1730
- default: {},
1731
- placeholder: 'Add Field',
1732
- options: [
1733
- {
1734
- displayName: 'Custom Query Parameters',
1735
- name: 'customParameters',
1736
- type: 'fixedCollection',
1737
- default: {},
1738
- placeholder: 'Add Parameter',
1739
- typeOptions: {
1740
- multipleValues: true,
1741
- },
1742
- options: [
1743
- {
1744
- name: 'parameter',
1745
- displayName: 'Parameter',
1746
- values: [
1747
- {
1748
- displayName: 'Key',
1749
- name: 'key',
1750
- type: 'string',
1751
- default: '',
1752
- },
1753
- {
1754
- displayName: 'Value',
1755
- name: 'value',
1756
- type: 'string',
1757
- default: '',
1758
- },
1759
- ],
1760
- },
1761
- ],
1762
- },
1763
- {
1764
- displayName: 'Expand',
1765
- name: 'expand',
1766
- type: 'string',
1767
- default: '',
1768
- description: 'Include additional resources by reference expansion',
1769
- },
1770
- {
1771
- displayName: 'Locale Projection',
1772
- name: 'localeProjection',
1773
- type: 'string',
1774
- default: '',
1775
- description: 'Select locales for returned localized fields',
1776
- },
1777
- {
1778
- displayName: 'Sort',
1779
- name: 'sort',
1780
- type: 'string',
1781
- default: '',
1782
- description: 'Sorting expression for query results, e.g. <code>createdAt desc</code>',
1783
- },
1784
- {
1785
- displayName: 'Where',
1786
- name: 'where',
1787
- type: 'string',
1788
- default: '',
1789
- description: 'Query predicate to filter categories',
1790
- },
1791
- {
1792
- displayName: 'With Total',
1793
- name: 'withTotal',
1794
- type: 'boolean',
1795
- default: true,
1796
- description: 'Whether the query should calculate the total number of matching categories',
1797
- },
1798
- ],
1799
- displayOptions: {
1800
- show: {
1801
- resource: ['category'],
1802
- operation: ['query'],
1803
- },
1804
- },
1805
- },
1806
- {
1807
- displayName: 'Return All',
1808
- name: 'categoryReturnAll',
1809
- type: 'boolean',
1810
- default: false,
1811
- displayOptions: {
1812
- show: {
1813
- resource: ['category'],
1814
- operation: ['query'],
1815
- },
1816
- },
1817
- description: 'Whether to return all results or only up to a given limit',
1818
- },
1819
- {
1820
- displayName: 'Limit',
1821
- name: 'categoryLimit',
1822
- type: 'number',
1823
- default: 50,
1824
- typeOptions: {
1825
- minValue: 1,
1826
- maxValue: 500,
1827
- },
1828
- displayOptions: {
1829
- show: {
1830
- resource: ['category'],
1831
- operation: ['query'],
1832
- categoryReturnAll: [false],
1833
- },
1834
- },
1835
- description: 'Max number of results to return',
1836
- },
1837
- {
1838
- displayName: 'Offset',
1839
- name: 'categoryOffset',
1840
- type: 'number',
1841
- default: 0,
1842
- typeOptions: {
1843
- minValue: 0,
1844
- },
1845
- displayOptions: {
1846
- show: {
1847
- resource: ['category'],
1848
- operation: ['query'],
1849
- },
1850
- },
1851
- description: 'Number of categories to skip before returning results',
1852
- },
1853
- {
1854
- displayName: 'Additional Fields',
1855
- name: 'categoryAdditionalFieldsGet',
1856
- type: 'collection',
1857
- default: {},
1858
- placeholder: 'Add Field',
1859
- options: [
1860
- {
1861
- displayName: 'Custom Query Parameters',
1862
- name: 'customParameters',
1863
- type: 'fixedCollection',
1864
- default: {},
1865
- placeholder: 'Add Parameter',
1866
- typeOptions: {
1867
- multipleValues: true,
1868
- },
1869
- options: [
1870
- {
1871
- name: 'parameter',
1872
- displayName: 'Parameter',
1873
- values: [
1874
- {
1875
- displayName: 'Key',
1876
- name: 'key',
1877
- type: 'string',
1878
- default: '',
1879
- },
1880
- {
1881
- displayName: 'Value',
1882
- name: 'value',
1883
- type: 'string',
1884
- default: '',
1885
- },
1886
- ],
1887
- },
1888
- ],
1889
- },
1890
- {
1891
- displayName: 'Expand',
1892
- name: 'expand',
1893
- type: 'string',
1894
- default: '',
1895
- description: 'Include additional resources by reference expansion',
1896
- },
1897
- {
1898
- displayName: 'Locale Projection',
1899
- name: 'localeProjection',
1900
- type: 'string',
1901
- default: '',
1902
- description: 'Select locales for returned localized fields',
1903
- },
1904
- ],
1905
- displayOptions: {
1906
- show: {
1907
- resource: ['category'],
1908
- operation: ['get', 'getByKey'],
1909
- },
1910
- },
1911
- },
1912
- {
1913
- displayName: 'Additional Fields',
1914
- name: 'categoryAdditionalFieldsCreate',
1915
- type: 'collection',
1916
- default: {},
1917
- placeholder: 'Add Field',
1918
- options: [
1919
- {
1920
- displayName: 'Custom Query Parameters',
1921
- name: 'customParameters',
1922
- type: 'fixedCollection',
1923
- default: {},
1924
- placeholder: 'Add Parameter',
1925
- typeOptions: {
1926
- multipleValues: true,
1927
- },
1928
- options: [
1929
- {
1930
- name: 'parameter',
1931
- displayName: 'Parameter',
1932
- values: [
1933
- {
1934
- displayName: 'Key',
1935
- name: 'key',
1936
- type: 'string',
1937
- default: '',
1938
- },
1939
- {
1940
- displayName: 'Value',
1941
- name: 'value',
1942
- type: 'string',
1943
- default: '',
1944
- },
1945
- ],
1946
- },
1947
- ],
1948
- },
1949
- {
1950
- displayName: 'Expand',
1951
- name: 'expand',
1952
- type: 'string',
1953
- default: '',
1954
- description: 'Include additional resources by reference expansion',
1955
- },
1956
- {
1957
- displayName: 'Locale Projection',
1958
- name: 'localeProjection',
1959
- type: 'string',
1960
- default: '',
1961
- description: 'Select locales for returned localized fields',
1962
- },
1963
- ],
1964
- displayOptions: {
1965
- show: {
1966
- resource: ['category'],
1967
- operation: ['create'],
1968
- },
1969
- },
1970
- },
1971
- {
1972
- displayName: 'Additional Fields',
1973
- name: 'categoryAdditionalFieldsUpdate',
1974
- type: 'collection',
1975
- default: {},
1976
- placeholder: 'Add Field',
1977
- options: [
1978
- {
1979
- displayName: 'Custom Query Parameters',
1980
- name: 'customParameters',
1981
- type: 'fixedCollection',
1982
- default: {},
1983
- placeholder: 'Add Parameter',
1984
- typeOptions: {
1985
- multipleValues: true,
1986
- },
1987
- options: [
1988
- {
1989
- name: 'parameter',
1990
- displayName: 'Parameter',
1991
- values: [
1992
- {
1993
- displayName: 'Key',
1994
- name: 'key',
1995
- type: 'string',
1996
- default: '',
1997
- },
1998
- {
1999
- displayName: 'Value',
2000
- name: 'value',
2001
- type: 'string',
2002
- default: '',
2003
- },
2004
- ],
2005
- },
2006
- ],
2007
- },
2008
- {
2009
- displayName: 'Expand',
2010
- name: 'expand',
2011
- type: 'string',
2012
- default: '',
2013
- description: 'Include additional resources by reference expansion',
2014
- },
2015
- {
2016
- displayName: 'Locale Projection',
2017
- name: 'localeProjection',
2018
- type: 'string',
2019
- default: '',
2020
- description: 'Select locales for returned localized fields',
2021
- },
2022
- ],
2023
- displayOptions: {
2024
- show: {
2025
- resource: ['category'],
2026
- operation: ['update', 'updateByKey'],
2027
- },
2028
- },
2029
- },
2030
- {
2031
- displayName: 'Additional Fields',
2032
- name: 'categoryAdditionalFieldsDelete',
2033
- type: 'collection',
2034
- default: {},
2035
- placeholder: 'Add Field',
2036
- options: [
2037
- {
2038
- displayName: 'Custom Query Parameters',
2039
- name: 'customParameters',
2040
- type: 'fixedCollection',
2041
- default: {},
2042
- placeholder: 'Add Parameter',
2043
- typeOptions: {
2044
- multipleValues: true,
2045
- },
2046
- options: [
2047
- {
2048
- name: 'parameter',
2049
- displayName: 'Parameter',
2050
- values: [
2051
- {
2052
- displayName: 'Key',
2053
- name: 'key',
2054
- type: 'string',
2055
- default: '',
2056
- },
2057
- {
2058
- displayName: 'Value',
2059
- name: 'value',
2060
- type: 'string',
2061
- default: '',
2062
- },
2063
- ],
2064
- },
2065
- ],
2066
- },
2067
- {
2068
- displayName: 'Expand',
2069
- name: 'expand',
2070
- type: 'string',
2071
- default: '',
2072
- description: 'Include additional resources by reference expansion',
2073
- },
2074
- {
2075
- displayName: 'Locale Projection',
2076
- name: 'localeProjection',
2077
- type: 'string',
2078
- default: '',
2079
- description: 'Select locales for returned localized fields',
2080
- },
2081
- ],
2082
- displayOptions: {
2083
- show: {
2084
- resource: ['category'],
2085
- operation: ['delete', 'deleteByKey'],
2086
- },
2087
- },
2088
- },
2089
- {
2090
- displayName: 'Customer ID',
2091
- name: 'customerId',
2092
- type: 'string',
2093
- default: '',
2094
- required: true,
2095
- displayOptions: {
2096
- show: {
2097
- resource: ['customer'],
2098
- operation: ['get', 'update', 'delete', 'head', 'changePassword', 'changePasswordInStore', 'getInStore', 'updateInStore', 'deleteInStore', 'headInStore', 'createEmailToken'],
2099
- },
2100
- },
2101
- description: 'The unique ID of the customer',
2102
- },
2103
- {
2104
- displayName: 'Customer Key',
2105
- name: 'customerKey',
2106
- type: 'string',
2107
- default: '',
2108
- required: true,
2109
- displayOptions: {
2110
- show: {
2111
- resource: ['customer'],
2112
- operation: ['getByKey', 'updateByKey', 'deleteByKey', 'headByKey', 'getInStoreByKey', 'updateInStoreByKey', 'deleteInStoreByKey', 'headInStoreByKey'],
2113
- },
2114
- },
2115
- description: 'The unique key of the customer',
2116
- },
2117
- {
2118
- displayName: 'Store Key',
2119
- name: 'storeKey',
2120
- type: 'string',
2121
- default: '',
2122
- required: true,
2123
- displayOptions: {
2124
- show: {
2125
- resource: ['customer'],
2126
- operation: ['authenticateInStore', 'changePasswordInStore', 'createInStore', 'getInStore', 'getInStoreByKey', 'getInStoreByEmailToken', 'getInStoreByPasswordToken', 'updateInStore', 'updateInStoreByKey', 'deleteInStore', 'deleteInStoreByKey', 'headInStore', 'headInStoreByKey', 'headInStoreByQuery', 'queryInStore', 'resetPasswordInStore', 'createPasswordResetTokenInStore', 'createEmailTokenInStore', 'verifyEmailInStore'],
2127
- },
2128
- },
2129
- description: 'The key of the store',
2130
- },
2131
- {
2132
- displayName: 'Email',
2133
- name: 'email',
2134
- type: 'string',
2135
- placeholder: 'name@email.com',
2136
- default: '',
2137
- required: true,
2138
- displayOptions: {
2139
- show: {
2140
- resource: ['customer'],
2141
- operation: ['authenticate', 'authenticateInStore', 'createPasswordResetToken', 'createPasswordResetTokenInStore'],
2142
- },
2143
- },
2144
- description: 'The email address of the customer',
2145
- },
2146
- {
2147
- displayName: 'Password',
2148
- name: 'password',
2149
- type: 'string',
2150
- typeOptions: {
2151
- password: true,
2152
- },
2153
- default: '',
2154
- required: true,
2155
- displayOptions: {
2156
- show: {
2157
- resource: ['customer'],
2158
- operation: ['authenticate', 'authenticateInStore'],
2159
- },
2160
- },
2161
- description: 'The password of the customer',
2162
- },
2163
- {
2164
- displayName: 'Current Password',
2165
- name: 'currentPassword',
2166
- type: 'string',
2167
- typeOptions: {
2168
- password: true,
2169
- },
2170
- default: '',
2171
- required: true,
2172
- displayOptions: {
2173
- show: {
2174
- resource: ['customer'],
2175
- operation: ['changePassword', 'changePasswordInStore'],
2176
- },
2177
- },
2178
- description: 'The current password of the customer',
2179
- },
2180
- {
2181
- displayName: 'New Password',
2182
- name: 'newPassword',
2183
- type: 'string',
2184
- typeOptions: {
2185
- password: true,
2186
- },
2187
- default: '',
2188
- required: true,
2189
- displayOptions: {
2190
- show: {
2191
- resource: ['customer'],
2192
- operation: ['changePassword', 'changePasswordInStore', 'resetPassword', 'resetPasswordInStore'],
2193
- },
2194
- },
2195
- description: 'The new password for the customer',
2196
- },
2197
- {
2198
- displayName: 'Password Token',
2199
- name: 'passwordToken',
2200
- type: 'string',
2201
- typeOptions: {
2202
- password: true,
2203
- },
2204
- default: '',
2205
- required: true,
2206
- displayOptions: {
2207
- show: {
2208
- resource: ['customer'],
2209
- operation: ['getByPasswordToken', 'getInStoreByPasswordToken'],
2210
- },
2211
- },
2212
- description: 'The password reset token',
2213
- },
2214
- {
2215
- displayName: 'Email Token',
2216
- name: 'emailToken',
2217
- type: 'string',
2218
- typeOptions: {
2219
- password: true,
2220
- },
2221
- default: '',
2222
- required: true,
2223
- displayOptions: {
2224
- show: {
2225
- resource: ['customer'],
2226
- operation: ['getByEmailToken', 'getInStoreByEmailToken'],
2227
- },
2228
- },
2229
- description: 'The email verification token',
2230
- },
2231
- {
2232
- displayName: 'Token Value',
2233
- name: 'tokenValue',
2234
- type: 'string',
2235
- typeOptions: {
2236
- password: true,
2237
- },
2238
- default: '',
2239
- required: true,
2240
- displayOptions: {
2241
- show: {
2242
- resource: ['customer'],
2243
- operation: ['resetPassword', 'resetPasswordInStore', 'verifyEmail', 'verifyEmailInStore'],
2244
- },
2245
- },
2246
- description: 'The token value for password reset or email verification',
2247
- },
2248
- {
2249
- displayName: 'Version',
2250
- name: 'version',
2251
- type: 'number',
2252
- default: 1,
2253
- required: true,
2254
- typeOptions: {
2255
- minValue: 1,
2256
- },
2257
- displayOptions: {
2258
- show: {
2259
- resource: ['customer'],
2260
- operation: ['update', 'updateByKey', 'updateInStore', 'updateInStoreByKey', 'delete', 'deleteByKey', 'deleteInStore', 'deleteInStoreByKey', 'changePassword', 'changePasswordInStore', 'createEmailToken', 'createEmailTokenInStore'],
2261
- },
2262
- },
2263
- description: 'Current version of the customer for optimistic locking',
2264
- },
2265
- {
2266
- displayName: 'TTL Minutes',
2267
- name: 'ttlMinutes',
2268
- type: 'number',
2269
- default: 4320,
2270
- required: true,
2271
- displayOptions: {
2272
- show: {
2273
- resource: ['customer'],
2274
- operation: ['createEmailToken', 'createEmailTokenInStore'],
2275
- },
2276
- },
2277
- description: 'Validity period of the generated token in minutes (default: 4320 = 3 days)',
2278
- },
2279
- {
2280
- displayName: 'Customer Draft (JSON)',
2281
- name: 'customerDraft',
2282
- type: 'json',
2283
- default: '{}',
2284
- required: true,
2285
- displayOptions: {
2286
- show: {
2287
- resource: ['customer'],
2288
- operation: ['create', 'createInStore'],
2289
- },
2290
- },
2291
- description: 'JSON representation of the customer draft to create, e.g. <code>{"email":"user@example.com","password":"secret","firstName":"John","lastName":"Doe"}</code>',
2292
- },
2293
- {
2294
- displayName: 'Actions (JSON)',
2295
- name: 'actions',
2296
- type: 'json',
2297
- default: '[]',
2298
- description: 'Update actions to apply to the resource',
2299
- displayOptions: {
2300
- show: {
2301
- resource: ['customer'],
2302
- operation: ['update', 'updateByKey'],
2303
- },
2304
- },
2305
- },
2306
- {
2307
- displayName: 'Actions (UI)',
2308
- name: 'customerActionsUi',
2309
- type: 'fixedCollection',
2310
- default: {},
2311
- placeholder: 'Add Action',
2312
- displayOptions: {
2313
- show: {
2314
- resource: ['customer'],
2315
- operation: ['update', 'updateByKey', 'updateInStore', 'updateInStoreByKey'],
2316
- },
2317
- },
2318
- typeOptions: {
2319
- multipleValues: true,
2320
- },
2321
- description: 'Update actions to perform on the customer',
2322
- options: [
2323
- {
2324
- displayName: 'Action',
2325
- name: 'action',
2326
- values: [
2327
- {
2328
- displayName: 'Action Type',
2329
- name: 'actionType',
2330
- type: 'options',
2331
- options: [
2332
- {
2333
- name: 'Add Address',
2334
- value: 'addAddress',
2335
- },
2336
- {
2337
- name: 'Add Billing Address ID',
2338
- value: 'addBillingAddressId',
2339
- },
2340
- {
2341
- name: 'Add CustomerGroupAssignment',
2342
- value: 'addCustomerGroupAssignment',
2343
- },
2344
- {
2345
- name: 'Add Shipping Address ID',
2346
- value: 'addShippingAddressId',
2347
- },
2348
- {
2349
- name: 'Add Store',
2350
- value: 'addStore',
2351
- },
2352
- {
2353
- name: 'Change Address',
2354
- value: 'changeAddress',
2355
- },
2356
- {
2357
- name: 'Change Email',
2358
- value: 'changeEmail',
2359
- },
2360
- {
2361
- name: 'Remove Address',
2362
- value: 'removeAddress',
2363
- },
2364
- {
2365
- name: 'Remove Billing Address ID',
2366
- value: 'removeBillingAddressId',
2367
- },
2368
- {
2369
- name: 'Remove CustomerGroupAssignment',
2370
- value: 'removeCustomerGroupAssignment',
2371
- },
2372
- {
2373
- name: 'Remove Shipping Address ID',
2374
- value: 'removeShippingAddressId',
2375
- },
2376
- {
2377
- name: 'Remove Store',
2378
- value: 'removeStore',
2379
- },
2380
- {
2381
- name: 'Set Authentication Mode',
2382
- value: 'setAuthenticationMode',
2383
- },
2384
- {
2385
- name: 'Set Company Name',
2386
- value: 'setCompanyName',
2387
- },
2388
- {
2389
- name: 'Set Custom Field',
2390
- value: 'setCustomField',
2391
- },
2392
- {
2393
- name: 'Set Custom Field in Address',
2394
- value: 'setCustomFieldInAddress',
2395
- },
2396
- {
2397
- name: 'Set Custom Type',
2398
- value: 'setCustomType',
2399
- },
2400
- {
2401
- name: 'Set Custom Type in Address',
2402
- value: 'setCustomTypeInAddress',
2403
- },
2404
- {
2405
- name: 'Set Customer Group',
2406
- value: 'setCustomerGroup',
2407
- },
2408
- {
2409
- name: 'Set Customer Number',
2410
- value: 'setCustomerNumber',
2411
- },
2412
- {
2413
- name: 'Set CustomerGroupAssignments',
2414
- value: 'setCustomerGroupAssignments',
2415
- },
2416
- {
2417
- name: 'Set Date of Birth',
2418
- value: 'setDateOfBirth',
2419
- },
2420
- {
2421
- name: 'Set Default Billing Address',
2422
- value: 'setDefaultBillingAddress',
2423
- },
2424
- {
2425
- name: 'Set Default Shipping Address',
2426
- value: 'setDefaultShippingAddress',
2427
- },
2428
- {
2429
- name: 'Set External ID',
2430
- value: 'setExternalId',
2431
- },
2432
- {
2433
- name: 'Set First Name',
2434
- value: 'setFirstName',
2435
- },
2436
- {
2437
- name: 'Set Last Name',
2438
- value: 'setLastName',
2439
- },
2440
- {
2441
- name: 'Set Locale',
2442
- value: 'setLocale',
2443
- },
2444
- {
2445
- name: 'Set Middle Name',
2446
- value: 'setMiddleName',
2447
- },
2448
- {
2449
- name: 'Set Salutation',
2450
- value: 'setSalutation',
2451
- },
2452
- {
2453
- name: 'Set Stores',
2454
- value: 'setStores',
2455
- },
2456
- {
2457
- name: 'Set Title',
2458
- value: 'setTitle',
2459
- },
2460
- {
2461
- name: 'Set Vat ID',
2462
- value: 'setVatId',
2463
- },
2464
- ],
2465
- default: 'changeEmail',
2466
- },
2467
- {
2468
- displayName: 'Additional Address Info',
2469
- name: 'additionalAddressInfo',
2470
- type: 'string',
2471
- default: '',
2472
- description: 'Additional address information',
2473
- displayOptions: {
2474
- show: {
2475
- actionType: ['addAddress', 'changeAddress'],
2476
- },
2477
- },
2478
- },
2479
- {
2480
- displayName: 'Additional Street Info',
2481
- name: 'additionalStreetInfo',
2482
- type: 'string',
2483
- default: '',
2484
- description: 'Additional street information',
2485
- displayOptions: {
2486
- show: {
2487
- actionType: ['addAddress', 'changeAddress'],
2488
- },
2489
- },
2490
- },
2491
- {
2492
- displayName: 'Address Email',
2493
- name: 'addressEmail',
2494
- type: 'string',
2495
- default: '',
2496
- description: 'Email address for this address (optional)',
2497
- displayOptions: {
2498
- show: {
2499
- actionType: ['addAddress', 'changeAddress'],
2500
- },
2501
- },
2502
- },
2503
- {
2504
- displayName: 'Address ID',
2505
- name: 'addressId',
2506
- type: 'string',
2507
- default: '',
2508
- description: 'ID of the address',
2509
- displayOptions: {
2510
- show: {
2511
- actionType: ['addBillingAddressId', 'addShippingAddressId', 'removeBillingAddressId', 'removeShippingAddressId', 'removeAddress', 'changeAddress', 'changeAddressId', 'setDefaultBillingAddress', 'setDefaultShippingAddress', 'setAddressCustomField', 'setAddressCustomType'],
2512
- addressReferenceType: ['id'],
2513
- },
2514
- },
2515
- },
2516
- {
2517
- displayName: 'Address Key',
2518
- name: 'addressKey',
2519
- type: 'string',
2520
- default: '',
2521
- description: 'Key of the address',
2522
- displayOptions: {
2523
- show: {
2524
- actionType: ['addBillingAddressId', 'addShippingAddressId', 'removeBillingAddressId', 'removeShippingAddressId', 'removeAddress', 'changeAddress', 'changeAddressId', 'setDefaultBillingAddress', 'setDefaultShippingAddress', 'setAddressCustomField', 'setAddressCustomType'],
2525
- addressReferenceType: ['key'],
2526
- },
2527
- },
2528
- },
2529
- {
2530
- displayName: 'Address Reference Type',
2531
- name: 'addressReferenceType',
2532
- type: 'options',
2533
- options: [
2534
- {
2535
- name: 'ID',
2536
- value: 'id',
2537
- description: 'Reference address by ID',
2538
- },
2539
- {
2540
- name: 'Key',
2541
- value: 'key',
2542
- description: 'Reference address by key',
2543
- },
2544
- ],
2545
- default: 'id',
2546
- description: 'Whether to reference the address by ID or key',
2547
- displayOptions: {
2548
- show: {
2549
- actionType: ['addBillingAddressId', 'addShippingAddressId', 'removeBillingAddressId', 'removeShippingAddressId', 'removeAddress', 'changeAddress', 'changeAddressId', 'setDefaultBillingAddress', 'setDefaultShippingAddress', 'setAddressCustomField', 'setAddressCustomType'],
2550
- },
2551
- },
2552
- },
2553
- {
2554
- displayName: 'Apartment',
2555
- name: 'apartment',
2556
- type: 'string',
2557
- default: '',
2558
- description: 'Apartment, suite, unit, etc (optional)',
2559
- displayOptions: {
2560
- show: {
2561
- actionType: ['addAddress', 'changeAddress'],
2562
- },
2563
- },
2564
- },
2565
- {
2566
- displayName: 'Authentication Mode',
2567
- name: 'authMode',
2568
- type: 'options',
2569
- options: [
2570
- {
2571
- name: 'Password',
2572
- value: 'Password',
2573
- },
2574
- {
2575
- name: 'External Auth',
2576
- value: 'ExternalAuth',
2577
- },
2578
- ],
2579
- default: 'Password',
2580
- description: 'Authentication mode for the customer',
2581
- displayOptions: {
2582
- show: {
2583
- actionType: ['setAuthenticationMode'],
2584
- },
2585
- },
2586
- },
2587
- {
2588
- displayName: 'Building',
2589
- name: 'building',
2590
- type: 'string',
2591
- default: '',
2592
- description: 'Building name or number (optional)',
2593
- displayOptions: {
2594
- show: {
2595
- actionType: ['addAddress', 'changeAddress'],
2596
- },
2597
- },
2598
- },
2599
- {
2600
- displayName: 'City',
2601
- name: 'city',
2602
- type: 'string',
2603
- default: '',
2604
- description: 'City name',
2605
- displayOptions: {
2606
- show: {
2607
- actionType: ['addAddress', 'changeAddress'],
2608
- },
2609
- },
2610
- },
2611
- {
2612
- displayName: 'Company Name',
2613
- name: 'companyName',
2614
- type: 'string',
2615
- default: '',
2616
- description: 'Company name for the customer',
2617
- displayOptions: {
2618
- show: {
2619
- actionType: ['setCompanyName'],
2620
- },
2621
- },
2622
- },
2623
- {
2624
- displayName: 'Country',
2625
- name: 'country',
2626
- type: 'string',
2627
- required: true,
2628
- default: '',
2629
- description: 'Country code (e.g., DE, US, GB) - Required',
2630
- displayOptions: {
2631
- show: {
2632
- actionType: ['addAddress', 'changeAddress'],
2633
- },
2634
- },
2635
- },
2636
- {
2637
- displayName: 'Customer Group ID',
2638
- name: 'customerGroupId',
2639
- type: 'string',
2640
- default: '',
2641
- description: 'ID of the customer group',
2642
- displayOptions: {
2643
- show: {
2644
- actionType: ['addCustomerGroupAssignment', 'removeCustomerGroupAssignment', 'setCustomerGroup'],
2645
- customerGroupReferenceType: ['id'],
2646
- },
2647
- },
2648
- },
2649
- {
2650
- displayName: 'Customer Group IDs',
2651
- name: 'customerGroupIds',
2652
- type: 'string',
2653
- default: '',
2654
- description: 'Comma-separated list of customer group IDs',
2655
- displayOptions: {
2656
- show: {
2657
- actionType: ['setCustomerGroupAssignments', 'addToCustomerGroup', 'removeFromCustomerGroup'],
2658
- customerGroupReferenceType: ['id'],
2659
- },
2660
- },
2661
- },
2662
- {
2663
- displayName: 'Customer Group Key',
2664
- name: 'customerGroupKey',
2665
- type: 'string',
2666
- default: '',
2667
- description: 'Key of the customer group',
2668
- displayOptions: {
2669
- show: {
2670
- actionType: ['addCustomerGroupAssignment', 'removeCustomerGroupAssignment', 'setCustomerGroup'],
2671
- customerGroupReferenceType: ['key'],
2672
- },
2673
- },
2674
- },
2675
- {
2676
- displayName: 'Customer Group Keys',
2677
- name: 'customerGroupKeys',
2678
- type: 'string',
2679
- default: '',
2680
- description: 'Comma-separated list of customer group keys',
2681
- displayOptions: {
2682
- show: {
2683
- actionType: ['setCustomerGroupAssignments', 'addToCustomerGroup', 'removeFromCustomerGroup'],
2684
- customerGroupReferenceType: ['key'],
2685
- },
2686
- },
2687
- },
2688
- {
2689
- displayName: 'Customer Group Reference Type',
2690
- name: 'customerGroupReferenceType',
2691
- type: 'options',
2692
- options: [
2693
- {
2694
- name: 'ID',
2695
- value: 'id',
2696
- description: 'Reference customer group by ID',
2697
- },
2698
- {
2699
- name: 'Key',
2700
- value: 'key',
2701
- description: 'Reference customer group by key',
2702
- },
2703
- ],
2704
- default: 'id',
2705
- description: 'Whether to reference the customer group by ID or key',
2706
- displayOptions: {
2707
- show: {
2708
- actionType: ['addCustomerGroupAssignment', 'removeCustomerGroupAssignment', 'setCustomerGroup', 'setCustomerGroupAssignments', 'addToCustomerGroup', 'removeFromCustomerGroup'],
2709
- },
2710
- },
2711
- },
2712
- {
2713
- displayName: 'Customer Number',
2714
- name: 'customerNumber',
2715
- type: 'string',
2716
- default: '',
2717
- description: 'Customer number for identification',
2718
- displayOptions: {
2719
- show: {
2720
- actionType: ['setCustomerNumber'],
2721
- },
2722
- },
2723
- },
2724
- {
2725
- displayName: 'Date of Birth',
2726
- name: 'dateOfBirth',
2727
- type: 'dateTime',
2728
- default: '',
2729
- description: 'Customer date of birth',
2730
- displayOptions: {
2731
- show: {
2732
- actionType: ['setDateOfBirth'],
2733
- },
2734
- },
2735
- },
2736
- {
2737
- displayName: 'Department',
2738
- name: 'department',
2739
- type: 'string',
2740
- default: '',
2741
- description: 'Department within building (optional)',
2742
- displayOptions: {
2743
- show: {
2744
- actionType: ['addAddress', 'changeAddress'],
2745
- },
2746
- },
2747
- },
2748
- {
2749
- displayName: 'Email',
2750
- name: 'email',
2751
- type: 'string',
2752
- default: '',
2753
- placeholder: 'name@email.com',
2754
- description: 'New email address',
2755
- displayOptions: {
2756
- show: {
2757
- actionType: ['changeEmail'],
2758
- },
2759
- },
2760
- },
2761
- {
2762
- displayName: 'External ID',
2763
- name: 'externalId',
2764
- type: 'string',
2765
- default: '',
2766
- description: 'External ID for the customer',
2767
- displayOptions: {
2768
- show: {
2769
- actionType: ['setExternalId'],
2770
- },
2771
- },
2772
- },
2773
- {
2774
- displayName: 'Fax',
2775
- name: 'fax',
2776
- type: 'string',
2777
- default: '',
2778
- description: 'Fax number (optional)',
2779
- displayOptions: {
2780
- show: {
2781
- actionType: ['addAddress', 'changeAddress'],
2782
- },
2783
- },
2784
- },
2785
- {
2786
- displayName: 'Field Name',
2787
- name: 'name',
2788
- type: 'string',
2789
- required: true,
2790
- default: '',
2791
- description: 'Name of the Custom Field',
2792
- displayOptions: {
2793
- show: {
2794
- actionType: ['setCustomField', 'setCustomFieldInAddress'],
2795
- },
2796
- },
2797
- },
2798
- {
2799
- displayName: 'Field Value',
2800
- name: 'value',
2801
- type: 'string',
2802
- default: '',
2803
- description: 'Value for the custom field (text, number, boolean, etc.)',
2804
- displayOptions: {
2805
- show: {
2806
- actionType: ['setCustomField', 'setAddressCustomField'],
2807
- },
2808
- },
2809
- },
2810
- {
2811
- displayName: 'Fields',
2812
- name: 'fields',
2813
- type: 'fixedCollection',
2814
- default: {},
2815
- description: 'Custom field values',
2816
- typeOptions: {
2817
- multipleValues: true,
2818
- },
2819
- options: [
2820
- {
2821
- displayName: 'Field',
2822
- name: 'field',
2823
- values: [
2824
- {
2825
- displayName: 'Name',
2826
- name: 'name',
2827
- type: 'string',
2828
- default: '',
2829
- description: 'The name of the custom field',
2830
- },
2831
- {
2832
- displayName: 'Value',
2833
- name: 'value',
2834
- type: 'string',
2835
- default: '',
2836
- description: 'The value of the custom field',
2837
- },
2838
- ],
2839
- },
2840
- ],
2841
- displayOptions: {
2842
- show: {
2843
- actionType: ['setCustomType', 'setCustomTypeInAddress'],
2844
- },
2845
- },
2846
- },
2847
- {
2848
- displayName: 'First Name',
2849
- name: 'firstName',
2850
- type: 'string',
2851
- default: '',
2852
- description: 'First name for the customer',
2853
- displayOptions: {
2854
- show: {
2855
- actionType: ['setFirstName'],
2856
- },
2857
- },
2858
- },
2859
- {
2860
- displayName: 'Key',
2861
- name: 'key',
2862
- type: 'string',
2863
- default: '',
2864
- description: 'Address key for identification (optional but recommended)',
2865
- displayOptions: {
2866
- show: {
2867
- actionType: ['addAddress', 'changeAddress'],
2868
- },
2869
- },
2870
- },
2871
- {
2872
- displayName: 'Last Name',
2873
- name: 'lastName',
2874
- type: 'string',
2875
- default: '',
2876
- description: 'Last name for the customer',
2877
- displayOptions: {
2878
- show: {
2879
- actionType: ['setLastName'],
2880
- },
2881
- },
2882
- },
2883
- {
2884
- displayName: 'Locale',
2885
- name: 'locale',
2886
- type: 'string',
2887
- default: '',
2888
- description: 'Locale for the customer (e.g., \'en-US\')',
2889
- displayOptions: {
2890
- show: {
2891
- actionType: ['setLocale'],
2892
- },
2893
- },
2894
- },
2895
- {
2896
- displayName: 'Middle Name',
2897
- name: 'middleName',
2898
- type: 'string',
2899
- default: '',
2900
- description: 'Middle name of the customer',
2901
- displayOptions: {
2902
- show: {
2903
- actionType: ['setMiddleName'],
2904
- },
2905
- },
2906
- },
2907
- {
2908
- displayName: 'Mobile',
2909
- name: 'mobile',
2910
- type: 'string',
2911
- default: '',
2912
- description: 'Mobile phone number (optional)',
2913
- displayOptions: {
2914
- show: {
2915
- actionType: ['addAddress', 'changeAddress'],
2916
- },
2917
- },
2918
- },
2919
- {
2920
- displayName: 'P.O. Box',
2921
- name: 'pOBox',
2922
- type: 'string',
2923
- default: '',
2924
- description: 'Post office box (optional)',
2925
- displayOptions: {
2926
- show: {
2927
- actionType: ['addAddress', 'changeAddress'],
2928
- },
2929
- },
2930
- },
2931
- {
2932
- displayName: 'Password',
2933
- name: 'password',
2934
- type: 'string',
2935
- typeOptions: { password: true },
2936
- default: '',
2937
- description: 'Password (required when setting to Password mode)',
2938
- displayOptions: {
2939
- show: {
2940
- actionType: ['setAuthenticationMode'],
2941
- authMode: ['Password'],
2942
- },
2943
- },
2944
- },
2945
- {
2946
- displayName: 'Phone',
2947
- name: 'phone',
2948
- type: 'string',
2949
- default: '',
2950
- description: 'Phone number (optional)',
2951
- displayOptions: {
2952
- show: {
2953
- actionType: ['addAddress', 'changeAddress'],
2954
- },
2955
- },
2956
- },
2957
- {
2958
- displayName: 'Postal Code',
2959
- name: 'postalCode',
2960
- type: 'string',
2961
- default: '',
2962
- description: 'Postal/ZIP code',
2963
- displayOptions: {
2964
- show: {
2965
- actionType: ['addAddress', 'changeAddress'],
2966
- },
2967
- },
2968
- },
2969
- {
2970
- displayName: 'Salutation',
2971
- name: 'salutation',
2972
- type: 'string',
2973
- default: '',
2974
- description: 'Customer salutation (e.g., Mr., Mrs., Dr.)',
2975
- displayOptions: {
2976
- show: {
2977
- actionType: ['setSalutation'],
2978
- },
2979
- },
2980
- },
2981
- {
2982
- displayName: 'State',
2983
- name: 'state',
2984
- type: 'string',
2985
- default: '',
2986
- description: 'State or region (optional)',
2987
- displayOptions: {
2988
- show: {
2989
- actionType: ['addAddress', 'changeAddress'],
2990
- },
2991
- },
2992
- },
2993
- {
2994
- displayName: 'Store ID',
2995
- name: 'storeId',
2996
- type: 'string',
2997
- default: '',
2998
- description: 'ID of the store',
2999
- displayOptions: {
3000
- show: {
3001
- actionType: ['addStore', 'removeStore'],
3002
- storeReferenceType: ['id'],
3003
- },
3004
- },
3005
- },
3006
- {
3007
- displayName: 'Store IDs',
3008
- name: 'storeIds',
3009
- type: 'string',
3010
- displayOptions: {
3011
- show: {
3012
- actionType: ['setStores'],
3013
- storeReferenceType: ['id'],
3014
- },
3015
- },
3016
- default: '',
3017
- description: 'Comma-separated list of store IDs',
3018
- },
3019
- {
3020
- displayName: 'Store Key',
3021
- name: 'storeKey',
3022
- type: 'string',
3023
- default: '',
3024
- description: 'Key of the store',
3025
- displayOptions: {
3026
- show: {
3027
- actionType: ['addStore', 'removeStore'],
3028
- storeReferenceType: ['key'],
3029
- },
3030
- },
3031
- },
3032
- {
3033
- displayName: 'Store Keys',
3034
- name: 'storeKeys',
3035
- type: 'string',
3036
- displayOptions: {
3037
- show: {
3038
- actionType: ['setStores'],
3039
- storeReferenceType: ['key'],
3040
- },
3041
- },
3042
- default: '',
3043
- description: 'Comma-separated list of store keys',
3044
- },
3045
- {
3046
- displayName: 'Store Reference Type',
3047
- name: 'storeReferenceType',
3048
- type: 'options',
3049
- options: [
3050
- {
3051
- name: 'ID',
3052
- value: 'id',
3053
- description: 'Reference store by ID',
3054
- },
3055
- {
3056
- name: 'Key',
3057
- value: 'key',
3058
- description: 'Reference store by key',
3059
- },
3060
- ],
3061
- default: 'id',
3062
- description: 'Whether to reference the store by ID or key',
3063
- displayOptions: {
3064
- show: {
3065
- actionType: ['addStore', 'removeStore', 'setStores'],
3066
- },
3067
- },
3068
- },
3069
- {
3070
- displayName: 'Street Name',
3071
- name: 'streetName',
3072
- type: 'string',
3073
- default: '',
3074
- displayOptions: {
3075
- show: {
3076
- actionType: ['addAddress', 'changeAddress'],
3077
- },
3078
- },
3079
- },
3080
- {
3081
- displayName: 'Street Number',
3082
- name: 'streetNumber',
3083
- type: 'string',
3084
- default: '',
3085
- displayOptions: {
3086
- show: {
3087
- actionType: ['addAddress', 'changeAddress'],
3088
- },
3089
- },
3090
- },
3091
- {
3092
- displayName: 'Title',
3093
- name: 'title',
3094
- type: 'string',
3095
- default: '',
3096
- description: 'Customer title (e.g., Mr., Mrs., Dr.)',
3097
- displayOptions: {
3098
- show: {
3099
- actionType: ['setTitle'],
3100
- },
3101
- },
3102
- },
3103
- {
3104
- displayName: 'Type ID',
3105
- name: 'typeId',
3106
- type: 'string',
3107
- default: '',
3108
- description: 'ID of the custom type',
3109
- displayOptions: {
3110
- show: {
3111
- actionType: ['setCustomType', 'setCustomTypeInAddress'],
3112
- typeReferenceType: ['id'],
3113
- },
3114
- },
3115
- },
3116
- {
3117
- displayName: 'Type Key',
3118
- name: 'typeKey',
3119
- type: 'string',
3120
- default: '',
3121
- description: 'Key of the custom type',
3122
- displayOptions: {
3123
- show: {
3124
- actionType: ['setCustomType', 'setCustomTypeInAddress'],
3125
- typeReferenceType: ['key'],
3126
- },
3127
- },
3128
- },
3129
- {
3130
- displayName: 'Type Reference Type',
3131
- name: 'typeReferenceType',
3132
- type: 'options',
3133
- options: [
3134
- {
3135
- name: 'ID',
3136
- value: 'id',
3137
- description: 'Reference type by ID',
3138
- },
3139
- {
3140
- name: 'Key',
3141
- value: 'key',
3142
- description: 'Reference type by key',
3143
- },
3144
- ],
3145
- default: 'key',
3146
- description: 'Whether to reference the custom type by ID or key',
3147
- displayOptions: {
3148
- show: {
3149
- actionType: ['setCustomType', 'setCustomTypeInAddress'],
3150
- },
3151
- },
3152
- },
3153
- {
3154
- displayName: 'VAT ID',
3155
- name: 'vatId',
3156
- type: 'string',
3157
- default: '',
3158
- description: 'VAT ID for the customer',
3159
- displayOptions: {
3160
- show: {
3161
- actionType: ['setVatId'],
3162
- },
3163
- },
3164
- },
3165
- ],
3166
- },
3167
- ],
3168
- },
3169
- {
3170
- displayName: 'Return All',
3171
- name: 'returnAll',
3172
- type: 'boolean',
3173
- default: false,
3174
- displayOptions: {
3175
- show: {
3176
- resource: ['customer'],
3177
- operation: ['query', 'queryInStore'],
3178
- },
3179
- },
3180
- description: 'Whether to return all results or only up to a given limit',
3181
- },
3182
- {
3183
- displayName: 'Limit',
3184
- name: 'limit',
3185
- type: 'number',
3186
- default: 50,
3187
- typeOptions: {
3188
- minValue: 1,
3189
- maxValue: 500,
3190
- },
3191
- displayOptions: {
3192
- show: {
3193
- resource: ['customer'],
3194
- operation: ['query', 'queryInStore'],
3195
- returnAll: [false],
3196
- },
3197
- },
3198
- description: 'Max number of results to return',
3199
- },
3200
- {
3201
- displayName: 'Offset',
3202
- name: 'offset',
3203
- type: 'number',
3204
- default: 0,
3205
- typeOptions: {
3206
- minValue: 0,
3207
- },
3208
- displayOptions: {
3209
- show: {
3210
- resource: ['customer'],
3211
- operation: ['query', 'queryInStore'],
3212
- },
3213
- },
3214
- description: 'Number of customers to skip before returning results',
3215
- },
3216
- {
3217
- displayName: 'Additional Fields',
3218
- name: 'additionalFields',
3219
- type: 'collection',
3220
- default: {},
3221
- placeholder: 'Add Field',
3222
- options: [
3223
- {
3224
- displayName: 'Anonymous Cart ID',
3225
- name: 'anonymousCartId',
3226
- type: 'string',
3227
- default: '',
3228
- description: 'The ID of the anonymous cart to merge with the customer cart',
3229
- },
3230
- {
3231
- displayName: 'Anonymous Cart Sign In Mode',
3232
- name: 'anonymousCartSignInMode',
3233
- type: 'options',
3234
- options: [
3235
- {
3236
- name: 'Merge With Existing Customer Cart',
3237
- value: 'MergeWithExistingCustomerCart',
3238
- },
3239
- {
3240
- name: 'Use As New Active Customer Cart',
3241
- value: 'UseAsNewActiveCustomerCart',
3242
- },
3243
- ],
3244
- default: 'MergeWithExistingCustomerCart',
3245
- description: 'How to handle the anonymous cart when signing in',
3246
- },
3247
- {
3248
- displayName: 'Anonymous ID',
3249
- name: 'anonymousId',
3250
- type: 'string',
3251
- default: '',
3252
- description: 'The ID of the anonymous session',
3253
- },
3254
- {
3255
- displayName: 'Custom Query Parameters',
3256
- name: 'customParameters',
3257
- type: 'fixedCollection',
3258
- default: {},
3259
- placeholder: 'Add Parameter',
3260
- typeOptions: {
3261
- multipleValues: true,
3262
- },
3263
- options: [
3264
- {
3265
- name: 'parameter',
3266
- displayName: 'Parameter',
3267
- values: [
3268
- {
3269
- displayName: 'Key',
3270
- name: 'key',
3271
- type: 'string',
3272
- default: '',
3273
- },
3274
- {
3275
- displayName: 'Value',
3276
- name: 'value',
3277
- type: 'string',
3278
- default: '',
3279
- },
3280
- ],
3281
- },
3282
- ],
3283
- },
3284
- {
3285
- displayName: 'Expand',
3286
- name: 'expand',
3287
- type: 'string',
3288
- default: '',
3289
- description: 'Include additional resources by reference expansion',
3290
- },
3291
- {
3292
- displayName: 'Predicate Variables',
3293
- name: 'predicateVariables',
3294
- type: 'fixedCollection',
3295
- default: {},
3296
- placeholder: 'Add Variable',
3297
- typeOptions: {
3298
- multipleValues: true,
3299
- },
3300
- options: [
3301
- {
3302
- name: 'variable',
3303
- displayName: 'Variable',
3304
- values: [
3305
- {
3306
- displayName: 'Name',
3307
- name: 'name',
3308
- type: 'string',
3309
- default: '',
3310
- },
3311
- {
3312
- displayName: 'Value',
3313
- name: 'value',
3314
- type: 'string',
3315
- default: '',
3316
- },
3317
- ],
3318
- },
3319
- ],
3320
- },
3321
- {
3322
- displayName: 'Sort',
3323
- name: 'sort',
3324
- type: 'string',
3325
- default: '',
3326
- description: 'Sort customers by specific fields',
3327
- },
3328
- {
3329
- displayName: 'TTL Minutes',
3330
- name: 'ttlMinutes',
3331
- type: 'number',
3332
- default: 10080,
3333
- description: 'Time to live for tokens in minutes (default: 7 days)',
3334
- },
3335
- {
3336
- displayName: 'Update Product Data',
3337
- name: 'updateProductData',
3338
- type: 'boolean',
3339
- default: false,
3340
- description: 'Whether to update product data in the cart',
3341
- },
3342
- {
3343
- displayName: 'Where',
3344
- name: 'where',
3345
- type: 'string',
3346
- default: '',
3347
- description: 'Query predicate to filter customers',
3348
- },
3349
- {
3350
- displayName: 'With Total',
3351
- name: 'withTotal',
3352
- type: 'boolean',
3353
- default: false,
3354
- description: 'Whether to include total count in the response',
3355
- },
3356
- ],
3357
- displayOptions: {
3358
- show: {
3359
- resource: ['customer'],
3360
- operation: ['authenticate', 'authenticateInStore', 'query', 'queryInStore', 'headByQuery', 'headInStoreByQuery', 'createPasswordResetToken', 'createPasswordResetTokenInStore', 'createEmailToken', 'createEmailTokenInStore'],
3361
- },
3362
- },
3363
- },
3364
- {
3365
- displayName: 'Additional Fields',
3366
- name: 'additionalFieldsGet',
3367
- type: 'collection',
3368
- default: {},
3369
- placeholder: 'Add Field',
3370
- options: [
3371
- {
3372
- displayName: 'Expand',
3373
- name: 'expand',
3374
- type: 'string',
3375
- default: '',
3376
- description: 'Include additional resources by reference expansion',
3377
- },
3378
- {
3379
- displayName: 'Custom Query Parameters',
3380
- name: 'customParameters',
3381
- type: 'fixedCollection',
3382
- default: {},
3383
- placeholder: 'Add Parameter',
3384
- typeOptions: {
3385
- multipleValues: true,
3386
- },
3387
- options: [
3388
- {
3389
- name: 'parameter',
3390
- displayName: 'Parameter',
3391
- values: [
3392
- {
3393
- displayName: 'Key',
3394
- name: 'key',
3395
- type: 'string',
3396
- default: '',
3397
- },
3398
- {
3399
- displayName: 'Value',
3400
- name: 'value',
3401
- type: 'string',
3402
- default: '',
3403
- },
3404
- ],
3405
- },
3406
- ],
3407
- },
3408
- ],
3409
- displayOptions: {
3410
- show: {
3411
- resource: ['customer'],
3412
- operation: ['get', 'getByKey', 'getByEmailToken', 'getByPasswordToken', 'getInStore', 'getInStoreByKey', 'getInStoreByEmailToken', 'getInStoreByPasswordToken'],
3413
- },
3414
- },
3415
- },
3416
- {
3417
- displayName: 'Additional Fields',
3418
- name: 'additionalFieldsCreate',
3419
- type: 'collection',
3420
- default: {},
3421
- placeholder: 'Add Field',
3422
- options: [
3423
- {
3424
- displayName: 'Expand',
3425
- name: 'expand',
3426
- type: 'string',
3427
- default: '',
3428
- description: 'Include additional resources by reference expansion',
3429
- },
3430
- ],
3431
- displayOptions: {
3432
- show: {
3433
- resource: ['customer'],
3434
- operation: ['create', 'createInStore'],
3435
- },
3436
- },
3437
- },
3438
- {
3439
- displayName: 'Additional Fields',
3440
- name: 'additionalFieldsUpdate',
3441
- type: 'collection',
3442
- default: {},
3443
- placeholder: 'Add Field',
3444
- options: [
3445
- {
3446
- displayName: 'Expand',
3447
- name: 'expand',
3448
- type: 'string',
3449
- default: '',
3450
- description: 'Include additional resources by reference expansion',
3451
- },
3452
- ],
3453
- displayOptions: {
3454
- show: {
3455
- resource: ['customer'],
3456
- operation: ['update', 'updateByKey', 'updateInStore', 'updateInStoreByKey'],
3457
- },
3458
- },
3459
- },
84
+ resourceField,
85
+ ...product_properties_1.productOperations,
86
+ ...category_properties_1.categoryOperations,
87
+ ...customer_description_1.customerOperations,
88
+ ...product_properties_1.productIdentificationFields,
89
+ ...category_properties_1.categoryBaseFields,
90
+ ...product_properties_1.productDraftFields,
91
+ ...sharedProductCategoryFields,
92
+ ...product_properties_1.productAdditionalFields,
93
+ ...category_properties_1.categoryAdditionalFields,
94
+ ...customer_description_1.customerFields,
3460
95
  ],
3461
96
  };
3462
97
  //# sourceMappingURL=Commercetools.description.js.map