@cloudcommerce/api 0.14.0 → 0.15.0

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.
@@ -1,1424 +0,0 @@
1
- /* tslint:disable */
2
- /**
3
- * This file was automatically generated by json-schema-to-typescript.
4
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5
- * and run json-schema-to-typescript to regenerate this file.
6
- */
7
-
8
- export interface Products {
9
- _id: string & { length: 24 };
10
- created_at: string;
11
- updated_at: string;
12
- store_id: number;
13
- /**
14
- * @maxItems 10
15
- */
16
- channel_ids?: string[];
17
- /**
18
- * Product unique reference code
19
- */
20
- sku: string;
21
- /**
22
- * Product type
23
- */
24
- commodity_type?: 'physical' | 'digital';
25
- /**
26
- * Product full name
27
- */
28
- name: string;
29
- /**
30
- * Slug to complete page URL, starting with number or lowercase letter
31
- */
32
- slug?: string;
33
- /**
34
- * Status defined by seller, such as draft or live
35
- */
36
- status?: string;
37
- /**
38
- * True when product is complete registered and ready to sell
39
- */
40
- available?: boolean;
41
- /**
42
- * Visible on search results, collections and catalogs
43
- */
44
- visible?: boolean;
45
- /**
46
- * Number to define the importance of the ad, the higher should be displayed first
47
- */
48
- ad_relevance?: number;
49
- /**
50
- * Short product description in plain text
51
- */
52
- short_description?: string;
53
- /**
54
- * Full product description, may use HTML tags
55
- */
56
- body_html?: string;
57
- /**
58
- * Full product description, plain text only
59
- */
60
- body_text?: string;
61
- /**
62
- * Title tag for page SEO
63
- */
64
- meta_title?: string;
65
- /**
66
- * Meta description tag for page SEO
67
- */
68
- meta_description?: string;
69
- /**
70
- * Text translations for internationalization
71
- */
72
- i18n?: {
73
- /**
74
- * Language specific text fields
75
- *
76
- * This interface was referenced by `undefined`'s JSON-Schema definition
77
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
78
- */
79
- [k: string]: {
80
- /**
81
- * Product full name
82
- */
83
- name?: string;
84
- /**
85
- * Short product description in plain text
86
- */
87
- short_description?: string;
88
- /**
89
- * Full product description, may use HTML tags
90
- */
91
- body_html?: string;
92
- /**
93
- * Full product description, plain text only
94
- */
95
- body_text?: string;
96
- /**
97
- * Title tag for page SEO
98
- */
99
- meta_title?: string;
100
- /**
101
- * Meta description tag for page SEO
102
- */
103
- meta_description?: string;
104
- };
105
- };
106
- /**
107
- * Tags related with product for internal search
108
- *
109
- * @maxItems 200
110
- */
111
- keywords?: string[];
112
- /**
113
- * Product sale price, when undefined, product could be bought by any price
114
- */
115
- price?: number;
116
- /**
117
- * How long sale price is valid, out of this range (if defined), base_price should be applied
118
- */
119
- price_effective_date?: {
120
- /**
121
- * Start date and time in ISO 8601 standard representation
122
- */
123
- start?: string;
124
- /**
125
- * Promotion end date and time in ISO 8601 standard representation
126
- */
127
- end?: string;
128
- };
129
- /**
130
- * Product original sale price, without discounts
131
- */
132
- base_price?: number;
133
- /**
134
- * Product cost price to calculate profit
135
- */
136
- cost_price?: number;
137
- /**
138
- * Designator of currency according to ISO 4217 (3 uppercase letters)
139
- */
140
- currency_id?: string;
141
- /**
142
- * Graphic symbol used as a shorthand for currency's name
143
- */
144
- currency_symbol?: string;
145
- /**
146
- * Product quantity available to sell, max to put in cart
147
- */
148
- quantity?: number;
149
- /**
150
- * Minimum quantity to put in cart
151
- */
152
- min_quantity?: number;
153
- /**
154
- * Warehouses by code and respective product stock
155
- */
156
- inventory?: {
157
- /**
158
- * Product quantity available for sale from current warehouse
159
- *
160
- * This interface was referenced by `undefined`'s JSON-Schema definition
161
- * via the `patternProperty` "^[A-Za-z0-9-_]{2,30}$".
162
- */
163
- [k: string]: number;
164
- };
165
- /**
166
- * Deadline for production or handling of pre-ordered product
167
- */
168
- production_time?: {
169
- /**
170
- * Number of days to post the product after purchase, deadline for production or handling
171
- */
172
- days: number;
173
- /**
174
- * If the deadline is calculated in working days
175
- */
176
- working_days?: boolean;
177
- /**
178
- * If the production time is cumulative per product unit
179
- */
180
- cumulative?: boolean;
181
- /**
182
- * When cumulative, increase the term proportionally up to this maximum (in days)
183
- */
184
- max_time?: number;
185
- };
186
- /**
187
- * Decrease product available quantity automatically after each order
188
- */
189
- manage_stock?: boolean;
190
- /**
191
- * Measure and dimension of your product when users might be interested in price per unit
192
- */
193
- measurement?: {
194
- /**
195
- * Unit of measurement
196
- */
197
- unit:
198
- | 'oz'
199
- | 'lb'
200
- | 'mg'
201
- | 'g'
202
- | 'kg'
203
- | 'floz'
204
- | 'pt'
205
- | 'qt'
206
- | 'gal'
207
- | 'ml'
208
- | 'cl'
209
- | 'l'
210
- | 'cbm'
211
- | 'in'
212
- | 'ft'
213
- | 'yd'
214
- | 'cm'
215
- | 'm'
216
- | 'sqft'
217
- | 'sqm'
218
- | 'ct';
219
- /**
220
- * Maximum number of decimal places in the product quantity (in unit of measure)
221
- */
222
- precision?: number;
223
- /**
224
- * Quantity to calculate the price to be shown on ads, such as GMC `unit_pricing_base_measure`
225
- */
226
- pricing_base_measure?: number;
227
- };
228
- /**
229
- * Product dimensions with packaging for freight calculation
230
- */
231
- dimensions?: {
232
- /**
233
- * Package width, height and length
234
- *
235
- * This interface was referenced by `undefined`'s JSON-Schema definition
236
- * via the `patternProperty` "^width|height|length$".
237
- */
238
- [k: string]: {
239
- /**
240
- * Size in specified unit
241
- */
242
- value: number;
243
- /**
244
- * Unit of measurement
245
- */
246
- unit?: 'mm' | 'cm' | 'm' | 'ft' | 'in' | 'yd' | 'mi';
247
- };
248
- };
249
- /**
250
- * Package weight for freight calculation
251
- */
252
- weight?: {
253
- /**
254
- * Size in specified unit
255
- */
256
- value: number;
257
- /**
258
- * Unit of measurement
259
- */
260
- unit?: 'mg' | 'g' | 'kg' | 'lb' | 'oz';
261
- };
262
- /**
263
- * Item condition
264
- */
265
- condition?: 'new' | 'refurbished' | 'used' | 'not_specified';
266
- /**
267
- * Product restricted to adults (18+)
268
- */
269
- adult?: boolean;
270
- /**
271
- * Warranty time and conditions
272
- */
273
- warranty?: string;
274
- /**
275
- * List of product brands
276
- *
277
- * @maxItems 100
278
- */
279
- brands?: {
280
- /**
281
- * Brand ID (ObjectID)
282
- */
283
- _id?: string;
284
- /**
285
- * Brand name
286
- */
287
- name: string;
288
- /**
289
- * Text translations for internationalization
290
- */
291
- i18n?: {
292
- /**
293
- * Language specific text fields
294
- *
295
- * This interface was referenced by `undefined`'s JSON-Schema definition
296
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
297
- */
298
- [k: string]: {
299
- /**
300
- * Brand name
301
- */
302
- name?: string;
303
- };
304
- };
305
- /**
306
- * Brand page slug
307
- */
308
- slug?: string;
309
- /**
310
- * Brand logo
311
- */
312
- logo?: {
313
- /**
314
- * Image link
315
- */
316
- url: string;
317
- /**
318
- * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
319
- */
320
- size?: string;
321
- /**
322
- * Alternative text, HTML alt tag (important for SEO)
323
- */
324
- alt?: string;
325
- };
326
- }[];
327
- /**
328
- * List of product categories
329
- *
330
- * @maxItems 100
331
- */
332
- categories?: {
333
- /**
334
- * Category ID (ObjectID)
335
- */
336
- _id?: string;
337
- /**
338
- * Category name
339
- */
340
- name: string;
341
- /**
342
- * Text translations for internationalization
343
- */
344
- i18n?: {
345
- /**
346
- * Language specific text fields
347
- *
348
- * This interface was referenced by `undefined`'s JSON-Schema definition
349
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
350
- */
351
- [k: string]: {
352
- /**
353
- * Category name
354
- */
355
- name?: string;
356
- };
357
- };
358
- /**
359
- * Category page slug
360
- */
361
- slug?: string;
362
- /**
363
- * Parent category (above) of current category
364
- */
365
- parent?: {
366
- /**
367
- * Parent category ID (ObjectID)
368
- */
369
- _id?: string;
370
- /**
371
- * Parent category name
372
- */
373
- name: string;
374
- /**
375
- * Text translations for internationalization
376
- */
377
- i18n?: {
378
- /**
379
- * Language specific text fields
380
- *
381
- * This interface was referenced by `undefined`'s JSON-Schema definition
382
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
383
- */
384
- [k: string]: {
385
- /**
386
- * Parent category name
387
- */
388
- name?: string;
389
- };
390
- };
391
- /**
392
- * Parent category page slug
393
- */
394
- slug?: string;
395
- };
396
- /**
397
- * Mercado Libre Taxonomy: https://api.mercadolibre.com/sites/MLB/categories
398
- */
399
- ml_category_id?: string;
400
- /**
401
- * Google Taxonomy: https://www.google.com/basepages/producttype/taxonomy-with-ids.pt-BR.txt
402
- */
403
- google_product_category_id?: number;
404
- }[];
405
- /**
406
- * Product's preferred category tree, separating by >, such as "Women > Dresses"
407
- */
408
- category_tree?: string;
409
- /**
410
- * Preferred category of the product in the Mercado Libre Taxonomy
411
- */
412
- ml_category_id?: string;
413
- /**
414
- * Preferred category of the product in the Google Products Taxonomy
415
- */
416
- google_product_category_id?: number;
417
- /**
418
- * Grids for specifications and variations
419
- *
420
- * @maxItems 200
421
- */
422
- grids?: {
423
- /**
424
- * Grid ID (ObjectID)
425
- */
426
- _id?: string;
427
- /**
428
- * Grid title
429
- */
430
- title: string;
431
- /**
432
- * Text translations for internationalization
433
- */
434
- i18n?: {
435
- /**
436
- * Language specific text fields
437
- *
438
- * This interface was referenced by `undefined`'s JSON-Schema definition
439
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
440
- */
441
- [k: string]: {
442
- /**
443
- * Grid title
444
- */
445
- title?: string;
446
- };
447
- };
448
- /**
449
- * Optional grid identifier for integrations, generally the grid name normalized
450
- */
451
- grid_id?: string;
452
- }[];
453
- /**
454
- * Product attributes and technical specifications
455
- */
456
- specifications?: {
457
- /**
458
- * Attribute to tell users the energy efficiency class of your product
459
- *
460
- * @maxItems 1
461
- */
462
- energy_efficiency_class?: {
463
- /**
464
- * Text displayed for the client describing the specification (custom value)
465
- */
466
- text: string;
467
- /**
468
- * Text translations for internationalization
469
- */
470
- i18n?: {
471
- /**
472
- * Language specific text fields
473
- *
474
- * This interface was referenced by `undefined`'s JSON-Schema definition
475
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
476
- */
477
- [k: string]: {
478
- /**
479
- * Text displayed for the client describing the specification (custom value)
480
- */
481
- text?: string;
482
- };
483
- };
484
- /**
485
- * Value in the Google Product Specification
486
- */
487
- value?: 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G';
488
- [k: string]: unknown;
489
- }[];
490
- /**
491
- * Attribute to set the demographic that your product is designed for
492
- *
493
- * @maxItems 1
494
- */
495
- age_group?: {
496
- /**
497
- * Text displayed for the client describing the specification (custom value)
498
- */
499
- text: string;
500
- /**
501
- * Text translations for internationalization
502
- */
503
- i18n?: {
504
- /**
505
- * Language specific text fields
506
- *
507
- * This interface was referenced by `undefined`'s JSON-Schema definition
508
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
509
- */
510
- [k: string]: {
511
- /**
512
- * Text displayed for the client describing the specification (custom value)
513
- */
514
- text?: string;
515
- };
516
- };
517
- /**
518
- * Value in the Google Product Specification
519
- */
520
- value?: 'newborn' | 'infant' | 'toddler' | 'kids' | 'adult';
521
- [k: string]: unknown;
522
- }[];
523
- /**
524
- * Specify for what gender your product is designed
525
- *
526
- * @maxItems 1
527
- */
528
- gender?: {
529
- /**
530
- * Text displayed for the client describing the specification (custom value)
531
- */
532
- text: string;
533
- /**
534
- * Text translations for internationalization
535
- */
536
- i18n?: {
537
- /**
538
- * Language specific text fields
539
- *
540
- * This interface was referenced by `undefined`'s JSON-Schema definition
541
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
542
- */
543
- [k: string]: {
544
- /**
545
- * Text displayed for the client describing the specification (custom value)
546
- */
547
- text?: string;
548
- };
549
- };
550
- /**
551
- * Value in the Google Product Specification
552
- */
553
- value?: 'male' | 'female' | 'unisex';
554
- [k: string]: unknown;
555
- }[];
556
- /**
557
- * Attribute to describe the main fabric or material that your product is made of
558
- *
559
- * @maxItems 1
560
- */
561
- material?: {
562
- /**
563
- * Text displayed for the client describing the attribute
564
- */
565
- text: string;
566
- /**
567
- * Text translations for internationalization
568
- */
569
- i18n?: {
570
- /**
571
- * Language specific text fields
572
- *
573
- * This interface was referenced by `undefined`'s JSON-Schema definition
574
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
575
- */
576
- [k: string]: {
577
- /**
578
- * Text displayed for the client describing the attribute
579
- */
580
- text?: string;
581
- };
582
- };
583
- /**
584
- * Default normalized value to use on GMC and other integrations
585
- */
586
- value?: string;
587
- [k: string]: unknown;
588
- }[];
589
- /**
590
- * Attribute to describe the pattern or graphic printed on your product
591
- *
592
- * @maxItems 1
593
- */
594
- pattern?: {
595
- /**
596
- * Text displayed for the client describing the attribute
597
- */
598
- text: string;
599
- /**
600
- * Text translations for internationalization
601
- */
602
- i18n?: {
603
- /**
604
- * Language specific text fields
605
- *
606
- * This interface was referenced by `undefined`'s JSON-Schema definition
607
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
608
- */
609
- [k: string]: {
610
- /**
611
- * Text displayed for the client describing the attribute
612
- */
613
- text?: string;
614
- };
615
- };
616
- /**
617
- * Default normalized value to use on GMC and other integrations
618
- */
619
- value?: string;
620
- [k: string]: unknown;
621
- }[];
622
- /**
623
- * Attribute to describe the standardized size of your product
624
- *
625
- * @maxItems 1
626
- */
627
- size?: {
628
- /**
629
- * Text displayed for the client describing the attribute
630
- */
631
- text: string;
632
- /**
633
- * Text translations for internationalization
634
- */
635
- i18n?: {
636
- /**
637
- * Language specific text fields
638
- *
639
- * This interface was referenced by `undefined`'s JSON-Schema definition
640
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
641
- */
642
- [k: string]: {
643
- /**
644
- * Text displayed for the client describing the attribute
645
- */
646
- text?: string;
647
- };
648
- };
649
- /**
650
- * Default normalized value to use on GMC and other integrations
651
- */
652
- value?: string;
653
- [k: string]: unknown;
654
- }[];
655
- /**
656
- * Attribute to describe the cut of your product
657
- *
658
- * @maxItems 1
659
- */
660
- size_type?: {
661
- /**
662
- * Text displayed for the client describing the attribute
663
- */
664
- text: string;
665
- /**
666
- * Text translations for internationalization
667
- */
668
- i18n?: {
669
- /**
670
- * Language specific text fields
671
- *
672
- * This interface was referenced by `undefined`'s JSON-Schema definition
673
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
674
- */
675
- [k: string]: {
676
- /**
677
- * Text displayed for the client describing the attribute
678
- */
679
- text?: string;
680
- };
681
- };
682
- /**
683
- * Value in the Google Product Specification
684
- */
685
- value?: 'regular' | 'petite' | 'plus' | 'big and tall' | 'maternity';
686
- [k: string]: unknown;
687
- }[];
688
- /**
689
- * Which country's sizing system your product uses
690
- *
691
- * @maxItems 1
692
- */
693
- size_system?: {
694
- /**
695
- * Text displayed for the client describing the attribute
696
- */
697
- text: string;
698
- /**
699
- * Text translations for internationalization
700
- */
701
- i18n?: {
702
- /**
703
- * Language specific text fields
704
- *
705
- * This interface was referenced by `undefined`'s JSON-Schema definition
706
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
707
- */
708
- [k: string]: {
709
- /**
710
- * Text displayed for the client describing the attribute
711
- */
712
- text?: string;
713
- };
714
- };
715
- /**
716
- * Value in the Google Product Specification
717
- */
718
- value?: 'AU' | 'BR' | 'CN' | 'DE' | 'EU' | 'FR' | 'IT' | 'JP' | 'MEX' | 'UK' | 'US';
719
- [k: string]: unknown;
720
- }[];
721
- /**
722
- * Product color palette, list ordered by importance, starting by main color
723
- */
724
- colors?: {
725
- /**
726
- * Color name
727
- */
728
- text: string;
729
- /**
730
- * Text translations for internationalization
731
- */
732
- i18n?: {
733
- /**
734
- * Language specific text fields
735
- *
736
- * This interface was referenced by `undefined`'s JSON-Schema definition
737
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
738
- */
739
- [k: string]: {
740
- /**
741
- * Color name
742
- */
743
- text?: string;
744
- };
745
- };
746
- /**
747
- * RGB code with #
748
- */
749
- value?: string;
750
- }[];
751
- /**
752
- * Custom product attributes, grid as property name (such as 'Model' and 'Voltage')
753
- *
754
- * @minItems 1
755
- * @maxItems 30
756
- *
757
- * This interface was referenced by `undefined`'s JSON-Schema definition
758
- * via the `patternProperty` "^.{2,70}$".
759
- */
760
- [k: string]: {
761
- /**
762
- * Text displayed for the client describing the specification
763
- */
764
- text: string;
765
- /**
766
- * Text translations for internationalization
767
- */
768
- i18n?: {
769
- /**
770
- * Language specific text fields
771
- *
772
- * This interface was referenced by `undefined`'s JSON-Schema definition
773
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
774
- */
775
- [k: string]: {
776
- /**
777
- * Text displayed for the client describing the specification
778
- */
779
- text?: string;
780
- };
781
- };
782
- /**
783
- * Default normalized value to use in integrations
784
- */
785
- value?: string;
786
- /**
787
- * Normalized values to use in specific integrations
788
- */
789
- external_values?: {
790
- /**
791
- * Attribute text external value
792
- *
793
- * This interface was referenced by `undefined`'s JSON-Schema definition
794
- * via the `patternProperty` "^[a-z0-9_]{2,50}$".
795
- */
796
- [k: string]: string;
797
- };
798
- }[];
799
- };
800
- /**
801
- * List of product images
802
- *
803
- * @maxItems 50
804
- */
805
- pictures?: {
806
- /**
807
- * Picture ID (ObjectID) [auto]
808
- */
809
- _id?: string;
810
- /**
811
- * Tag to identify object, use only lowercase letters, digits and underscore
812
- */
813
- tag?: string;
814
- normal?: PictureSize;
815
- big?: PictureSize1;
816
- zoom?: PictureSize2;
817
- small?: PictureSize3;
818
- }[];
819
- /**
820
- * List of videos related to your product
821
- *
822
- * @maxItems 30
823
- */
824
- videos?: {
825
- /**
826
- * Video link
827
- */
828
- url: string;
829
- /**
830
- * Title describing the video
831
- */
832
- title?: string;
833
- }[];
834
- /**
835
- * List of product customization fields
836
- *
837
- * @maxItems 100
838
- */
839
- customizations?: (
840
- | {
841
- [k: string]: unknown;
842
- }
843
- | {
844
- [k: string]: unknown;
845
- }
846
- )[];
847
- /**
848
- * Product variations list
849
- *
850
- * @maxItems 3000
851
- */
852
- variations?: {
853
- /**
854
- * Variation ID (ObjectID) [auto]
855
- */
856
- _id?: string;
857
- /**
858
- * Item unique reference code
859
- */
860
- sku?: string;
861
- /**
862
- * Product name for this specific variation
863
- */
864
- name?: string;
865
- /**
866
- * Text translations for internationalization
867
- */
868
- i18n?: {
869
- /**
870
- * Language specific text fields
871
- *
872
- * This interface was referenced by `undefined`'s JSON-Schema definition
873
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
874
- */
875
- [k: string]: {
876
- /**
877
- * Product name for this specific variation
878
- */
879
- name?: string;
880
- };
881
- };
882
- /**
883
- * Global Trade Item Numbers (barcode number): UPC, EAN, JAN, ISBN, ITF-14
884
- */
885
- gtin?: string;
886
- /**
887
- * Unique code specified by manufacturer to identify the product
888
- */
889
- mpn?: string;
890
- /**
891
- * List of product NCM codes
892
- *
893
- * @maxItems 10
894
- */
895
- ncm?: string[];
896
- /**
897
- * Variation sale price, when undefined, product default price should be used
898
- */
899
- price?: number;
900
- /**
901
- * Variation original sale price, without discounts
902
- */
903
- base_price?: number;
904
- /**
905
- * Variation cost price to calculate profit
906
- */
907
- cost_price?: number;
908
- /**
909
- * Product quantity available to sell, max to put in cart
910
- */
911
- quantity?: number;
912
- /**
913
- * Minimum quantity to put in cart
914
- */
915
- min_quantity?: number;
916
- /**
917
- * Warehouses by code and respective variation stock
918
- */
919
- inventory?: {
920
- /**
921
- * Variation quantity available for sale from current warehouse
922
- *
923
- * This interface was referenced by `undefined`'s JSON-Schema definition
924
- * via the `patternProperty` "^[A-Za-z0-9-_]{2,30}$".
925
- */
926
- [k: string]: number;
927
- };
928
- /**
929
- * Deadline for production or handling of pre-ordered product
930
- */
931
- production_time?: {
932
- /**
933
- * Number of days to post after purchase, deadline for production or handling
934
- */
935
- days: number;
936
- /**
937
- * If the deadline is calculated in working days
938
- */
939
- working_days?: boolean;
940
- /**
941
- * If the production time is cumulative per unit
942
- */
943
- cumulative?: boolean;
944
- /**
945
- * When cumulative, increase up to this maximum in days
946
- */
947
- max_time?: number;
948
- };
949
- /**
950
- * Product dimensions with packaging for freight calculation
951
- */
952
- dimensions?: {
953
- /**
954
- * Package width, height and length
955
- *
956
- * This interface was referenced by `undefined`'s JSON-Schema definition
957
- * via the `patternProperty` "^width|height|length$".
958
- */
959
- [k: string]: {
960
- /**
961
- * Size in specified unit
962
- */
963
- value: number;
964
- /**
965
- * Unit of measurement
966
- */
967
- unit?: 'mm' | 'cm' | 'm' | 'ft' | 'in' | 'yd' | 'mi';
968
- };
969
- };
970
- /**
971
- * Package weight for freight calculation
972
- */
973
- weight?: {
974
- /**
975
- * Size in specified unit
976
- */
977
- value: number;
978
- /**
979
- * Unit of measurement
980
- */
981
- unit?: 'mg' | 'g' | 'kg' | 'lb' | 'oz';
982
- };
983
- /**
984
- * Variation attributes and technical specifications
985
- */
986
- specifications: {
987
- /**
988
- * Attribute to describe the main fabric or material that your product is made of
989
- *
990
- * @maxItems 1
991
- */
992
- material?: {
993
- /**
994
- * Text displayed for the client describing the attribute
995
- */
996
- text: string;
997
- /**
998
- * Text translations for internationalization
999
- */
1000
- i18n?: {
1001
- /**
1002
- * Language specific text fields
1003
- *
1004
- * This interface was referenced by `undefined`'s JSON-Schema definition
1005
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1006
- */
1007
- [k: string]: {
1008
- /**
1009
- * Text displayed for the client describing the attribute
1010
- */
1011
- text?: string;
1012
- };
1013
- };
1014
- /**
1015
- * Default normalized value to use on GMC and other integrations
1016
- */
1017
- value?: string;
1018
- [k: string]: unknown;
1019
- }[];
1020
- /**
1021
- * Attribute to describe the pattern or graphic printed on your product
1022
- *
1023
- * @maxItems 1
1024
- */
1025
- pattern?: {
1026
- /**
1027
- * Text displayed for the client describing the attribute
1028
- */
1029
- text: string;
1030
- /**
1031
- * Text translations for internationalization
1032
- */
1033
- i18n?: {
1034
- /**
1035
- * Language specific text fields
1036
- *
1037
- * This interface was referenced by `undefined`'s JSON-Schema definition
1038
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1039
- */
1040
- [k: string]: {
1041
- /**
1042
- * Text displayed for the client describing the attribute
1043
- */
1044
- text?: string;
1045
- };
1046
- };
1047
- /**
1048
- * Default normalized value to use on GMC and other integrations
1049
- */
1050
- value?: string;
1051
- [k: string]: unknown;
1052
- }[];
1053
- /**
1054
- * Attribute to describe the standardized size of your product
1055
- *
1056
- * @maxItems 1
1057
- */
1058
- size?: {
1059
- /**
1060
- * Text displayed for the client describing the attribute
1061
- */
1062
- text: string;
1063
- /**
1064
- * Text translations for internationalization
1065
- */
1066
- i18n?: {
1067
- /**
1068
- * Language specific text fields
1069
- *
1070
- * This interface was referenced by `undefined`'s JSON-Schema definition
1071
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1072
- */
1073
- [k: string]: {
1074
- /**
1075
- * Text displayed for the client describing the attribute
1076
- */
1077
- text?: string;
1078
- };
1079
- };
1080
- /**
1081
- * Default normalized value to use on GMC and other integrations
1082
- */
1083
- value?: string;
1084
- [k: string]: unknown;
1085
- }[];
1086
- /**
1087
- * Variation color palette, list ordered by importance, starting by main color
1088
- */
1089
- colors?: {
1090
- /**
1091
- * Color name
1092
- */
1093
- text: string;
1094
- /**
1095
- * Text translations for internationalization
1096
- */
1097
- i18n?: {
1098
- /**
1099
- * Language specific text fields
1100
- *
1101
- * This interface was referenced by `undefined`'s JSON-Schema definition
1102
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1103
- */
1104
- [k: string]: {
1105
- /**
1106
- * Color name
1107
- */
1108
- text?: string;
1109
- };
1110
- };
1111
- /**
1112
- * RGB code with #
1113
- */
1114
- value?: string;
1115
- }[];
1116
- /**
1117
- * Custom variation attributes, grid as property name (such as 'Model' and 'Voltage')
1118
- *
1119
- * @minItems 1
1120
- * @maxItems 6
1121
- *
1122
- * This interface was referenced by `undefined`'s JSON-Schema definition
1123
- * via the `patternProperty` "^.{2,70}$".
1124
- */
1125
- [k: string]: {
1126
- /**
1127
- * Text displayed for the client describing the specification
1128
- */
1129
- text: string;
1130
- /**
1131
- * Text translations for internationalization
1132
- */
1133
- i18n?: {
1134
- /**
1135
- * Language specific text fields
1136
- *
1137
- * This interface was referenced by `undefined`'s JSON-Schema definition
1138
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1139
- */
1140
- [k: string]: {
1141
- /**
1142
- * Text displayed for the client describing the specification
1143
- */
1144
- text?: string;
1145
- };
1146
- };
1147
- /**
1148
- * Default normalized value to use in integrations
1149
- */
1150
- value?: string;
1151
- /**
1152
- * Normalized values to use in specific integrations
1153
- */
1154
- external_values?: {
1155
- /**
1156
- * Attribute text external value
1157
- *
1158
- * This interface was referenced by `undefined`'s JSON-Schema definition
1159
- * via the `patternProperty` "^[a-z0-9_]{2,50}$".
1160
- */
1161
- [k: string]: string;
1162
- };
1163
- }[];
1164
- };
1165
- /**
1166
- * ID of one of the preferred product picture for this variation
1167
- */
1168
- picture_id?: string;
1169
- /**
1170
- * Flags to associate additional info
1171
- *
1172
- * @maxItems 10
1173
- */
1174
- flags?: string[];
1175
- }[];
1176
- /**
1177
- * If this product is a kit, set its composition
1178
- *
1179
- * @maxItems 100
1180
- */
1181
- kit_composition?: {
1182
- /**
1183
- * Product ID (ObjectID)
1184
- */
1185
- _id: string & { length: 24 };
1186
- /**
1187
- * Product quantity
1188
- */
1189
- quantity?: number;
1190
- /**
1191
- * Label shown to customer, if you want to use a title other than the product name
1192
- */
1193
- label?: string;
1194
- /**
1195
- * Text translations for internationalization
1196
- */
1197
- i18n?: {
1198
- /**
1199
- * Language specific text fields
1200
- *
1201
- * This interface was referenced by `undefined`'s JSON-Schema definition
1202
- * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
1203
- */
1204
- [k: string]: {
1205
- /**
1206
- * Label shown to customer, if you want to use a title other than the product name
1207
- */
1208
- label?: string;
1209
- };
1210
- };
1211
- /**
1212
- * If this product has variations
1213
- */
1214
- has_variations?: boolean;
1215
- /**
1216
- * Optional variation ID (ObjectID) if `has_variations` is true
1217
- */
1218
- variation_id?: string;
1219
- }[];
1220
- /**
1221
- * Parent product ID, if this product is contained or represented by another
1222
- */
1223
- parent_item_id?: string;
1224
- /**
1225
- * Lists of related products
1226
- *
1227
- * @maxItems 30
1228
- */
1229
- related_products?: {
1230
- /**
1231
- * Title describing the video
1232
- */
1233
- title?: string;
1234
- /**
1235
- * Unit of measurement
1236
- */
1237
- relation_type?: 'common_characteristics' | 'common_orders' | 'manual' | 'other';
1238
- /**
1239
- * List of products
1240
- *
1241
- * @maxItems 100
1242
- */
1243
- product_ids: string[];
1244
- /**
1245
- * Tag to identify object, use only lowercase letters, digits and underscore
1246
- */
1247
- tag?: string;
1248
- }[];
1249
- /**
1250
- * True when related products lists should be created and updated automatically (ML)
1251
- */
1252
- auto_fill_related_products?: boolean;
1253
- /**
1254
- * Product popularity, will be filled automatically
1255
- */
1256
- views?: number;
1257
- /**
1258
- * On how many orders this product is present, filled automatically
1259
- */
1260
- sales?: number;
1261
- /**
1262
- * Total amount earned with sales of this product, filled automatically
1263
- */
1264
- total_sold?: number;
1265
- /**
1266
- * List of product GTIN codes
1267
- *
1268
- * @maxItems 10
1269
- */
1270
- gtin?: string[];
1271
- /**
1272
- * List of product MPN codes
1273
- *
1274
- * @maxItems 10
1275
- */
1276
- mpn?: string[];
1277
- /**
1278
- * List of product NCM codes
1279
- *
1280
- * @maxItems 10
1281
- */
1282
- ncm?: string[];
1283
- /**
1284
- * Whether the product is sold by a third party, usual in marketplaces
1285
- */
1286
- seller?: {
1287
- /**
1288
- * Unique reference code to identify this seller
1289
- */
1290
- code?: string;
1291
- /**
1292
- * Seller name
1293
- */
1294
- name?: string;
1295
- /**
1296
- * Image link to seller's logo
1297
- */
1298
- logo_url?: string;
1299
- /**
1300
- * Short description of seller
1301
- */
1302
- description?: string;
1303
- };
1304
- /**
1305
- * List of custom attributes
1306
- *
1307
- * @maxItems 100
1308
- */
1309
- metafields?: {
1310
- /**
1311
- * String to help distinguish who (or which app) created and can use the metafield
1312
- */
1313
- namespace?: string;
1314
- /**
1315
- * Field name
1316
- */
1317
- field?: string;
1318
- /**
1319
- * Custom property value
1320
- */
1321
- value: {
1322
- [k: string]: unknown;
1323
- };
1324
- }[];
1325
- /**
1326
- * List of custom attributes
1327
- *
1328
- * @maxItems 100
1329
- */
1330
- hidden_metafields?: {
1331
- /**
1332
- * String to help distinguish who (or which app) created and can use the metafield
1333
- */
1334
- namespace?: string;
1335
- /**
1336
- * Field name
1337
- */
1338
- field?: string;
1339
- /**
1340
- * Custom property value
1341
- */
1342
- value: {
1343
- [k: string]: unknown;
1344
- };
1345
- }[];
1346
- /**
1347
- * Flags to associate additional info
1348
- *
1349
- * @maxItems 10
1350
- */
1351
- flags?: string[];
1352
- /**
1353
- * Optional notes with additional info about this product
1354
- */
1355
- notes?: string;
1356
- }
1357
- /**
1358
- * Default image size variant
1359
- */
1360
- export interface PictureSize {
1361
- /**
1362
- * Image link
1363
- */
1364
- url: string;
1365
- /**
1366
- * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
1367
- */
1368
- size?: string;
1369
- /**
1370
- * Alternative text, HTML alt tag (important for SEO)
1371
- */
1372
- alt?: string;
1373
- }
1374
- /**
1375
- * Image big size variant
1376
- */
1377
- export interface PictureSize1 {
1378
- /**
1379
- * Image link
1380
- */
1381
- url: string;
1382
- /**
1383
- * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
1384
- */
1385
- size?: string;
1386
- /**
1387
- * Alternative text, HTML alt tag (important for SEO)
1388
- */
1389
- alt?: string;
1390
- }
1391
- /**
1392
- * Image zoom size variant
1393
- */
1394
- export interface PictureSize2 {
1395
- /**
1396
- * Image link
1397
- */
1398
- url: string;
1399
- /**
1400
- * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
1401
- */
1402
- size?: string;
1403
- /**
1404
- * Alternative text, HTML alt tag (important for SEO)
1405
- */
1406
- alt?: string;
1407
- }
1408
- /**
1409
- * Image small size variant
1410
- */
1411
- export interface PictureSize3 {
1412
- /**
1413
- * Image link
1414
- */
1415
- url: string;
1416
- /**
1417
- * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
1418
- */
1419
- size?: string;
1420
- /**
1421
- * Alternative text, HTML alt tag (important for SEO)
1422
- */
1423
- alt?: string;
1424
- }