forked from edgio-docs/edgio-nextjs-commerce-example
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.d.ts
2064 lines (1916 loc) · 59.1 KB
/
schema.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export type Maybe<T> = T | null
export type Exact<T extends { [key: string]: unknown }> = {
[K in keyof T]: T[K]
}
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: string
String: string
Boolean: boolean
Int: number
Float: number
DateTime: any
/** The `BigDecimal` scalar type represents signed fractional values with arbitrary precision. */
BigDecimal: any
/** The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1. */
Long: any
}
/** Login result */
export type LoginResult = {
__typename?: 'LoginResult'
/** The result of a login */
result: Scalars['String']
}
/** Logout result */
export type LogoutResult = {
__typename?: 'LogoutResult'
/** The result of a logout */
result: Scalars['String']
}
export type Mutation = {
__typename?: 'Mutation'
login: LoginResult
logout: LogoutResult
}
export type MutationLoginArgs = {
email: Scalars['String']
password: Scalars['String']
}
/** Aggregated */
export type Aggregated = {
__typename?: 'Aggregated'
/** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
availableToSell: Scalars['Long']
/** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
warningLevel: Scalars['Int']
}
/** Aggregated Product Inventory */
export type AggregatedInventory = {
__typename?: 'AggregatedInventory'
/** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
availableToSell: Scalars['Int']
/** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
warningLevel: Scalars['Int']
}
/** Brand */
export type Brand = Node & {
__typename?: 'Brand'
/** The ID of an object */
id: Scalars['ID']
/** Id of the brand. */
entityId: Scalars['Int']
/** Name of the brand. */
name: Scalars['String']
/** Default image for brand. */
defaultImage?: Maybe<Image>
/** Page title for the brand. */
pageTitle: Scalars['String']
/** Meta description for the brand. */
metaDesc: Scalars['String']
/** Meta keywords for the brand. */
metaKeywords: Array<Scalars['String']>
/** Search keywords for the brand. */
searchKeywords: Array<Scalars['String']>
/** Path for the brand page. */
path: Scalars['String']
products: ProductConnection
/** Metafield data related to a brand. */
metafields: MetafieldConnection
}
/** Brand */
export type BrandProductsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Brand */
export type BrandMetafieldsArgs = {
namespace: Scalars['String']
keys?: Maybe<Array<Scalars['String']>>
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** A connection to a list of items. */
export type BrandConnection = {
__typename?: 'BrandConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<BrandEdge>>>
}
/** An edge in a connection. */
export type BrandEdge = {
__typename?: 'BrandEdge'
/** The item at the end of the edge. */
node: Brand
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** Breadcrumb */
export type Breadcrumb = {
__typename?: 'Breadcrumb'
/** Category id. */
entityId: Scalars['Int']
/** Name of the category. */
name: Scalars['String']
}
/** A connection to a list of items. */
export type BreadcrumbConnection = {
__typename?: 'BreadcrumbConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<BreadcrumbEdge>>>
}
/** An edge in a connection. */
export type BreadcrumbEdge = {
__typename?: 'BreadcrumbEdge'
/** The item at the end of the edge. */
node: Breadcrumb
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** Bulk pricing tier that sets a fixed price for the product or variant. */
export type BulkPricingFixedPriceDiscount = BulkPricingTier & {
__typename?: 'BulkPricingFixedPriceDiscount'
/** This price will override the current product price. */
price: Scalars['BigDecimal']
/** Minimum item quantity that applies to this bulk pricing tier. */
minimumQuantity: Scalars['Int']
/** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
maximumQuantity?: Maybe<Scalars['Int']>
}
/** Bulk pricing tier that reduces the price of the product or variant by a percentage. */
export type BulkPricingPercentageDiscount = BulkPricingTier & {
__typename?: 'BulkPricingPercentageDiscount'
/** The percentage that will be removed from the product price. */
percentOff: Scalars['BigDecimal']
/** Minimum item quantity that applies to this bulk pricing tier. */
minimumQuantity: Scalars['Int']
/** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
maximumQuantity?: Maybe<Scalars['Int']>
}
/** Bulk pricing tier that will subtract an amount from the price of the product or variant. */
export type BulkPricingRelativePriceDiscount = BulkPricingTier & {
__typename?: 'BulkPricingRelativePriceDiscount'
/** The price of the product/variant will be reduced by this priceAdjustment. */
priceAdjustment: Scalars['BigDecimal']
/** Minimum item quantity that applies to this bulk pricing tier. */
minimumQuantity: Scalars['Int']
/** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
maximumQuantity?: Maybe<Scalars['Int']>
}
/** A set of bulk pricing tiers that define price discounts which apply when purchasing specified quantities of a product or variant. */
export type BulkPricingTier = {
/** Minimum item quantity that applies to this bulk pricing tier. */
minimumQuantity: Scalars['Int']
/** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
maximumQuantity?: Maybe<Scalars['Int']>
}
/** Product Option */
export type CatalogProductOption = {
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** Product Option Value */
export type CatalogProductOptionValue = {
/** Unique ID for the option value. */
entityId: Scalars['Int']
/** Label for the option value. */
label: Scalars['String']
/** Indicates whether this value is the chosen default selected value. */
isDefault: Scalars['Boolean']
}
/** Category */
export type Category = Node & {
__typename?: 'Category'
/** The ID of an object */
id: Scalars['ID']
/** Unique ID for the category. */
entityId: Scalars['Int']
/** Category name. */
name: Scalars['String']
/** Category path. */
path: Scalars['String']
/** Default image for the category. */
defaultImage?: Maybe<Image>
/** Category description. */
description: Scalars['String']
/** Category breadcrumbs. */
breadcrumbs: BreadcrumbConnection
products: ProductConnection
/** Metafield data related to a category. */
metafields: MetafieldConnection
}
/** Category */
export type CategoryBreadcrumbsArgs = {
depth: Scalars['Int']
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Category */
export type CategoryProductsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Category */
export type CategoryMetafieldsArgs = {
namespace: Scalars['String']
keys?: Maybe<Array<Scalars['String']>>
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** A connection to a list of items. */
export type CategoryConnection = {
__typename?: 'CategoryConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<CategoryEdge>>>
}
/** An edge in a connection. */
export type CategoryEdge = {
__typename?: 'CategoryEdge'
/** The item at the end of the edge. */
node: Category
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** An item in a tree of categories. */
export type CategoryTreeItem = {
__typename?: 'CategoryTreeItem'
/** The id category. */
entityId: Scalars['Int']
/** The name of category. */
name: Scalars['String']
/** Path assigned to this category */
path: Scalars['String']
/** The description of this category. */
description: Scalars['String']
/** The number of products in this category. */
productCount: Scalars['Int']
/** Subcategories of this category */
children: Array<CategoryTreeItem>
}
/** A simple yes/no question represented by a checkbox. */
export type CheckboxOption = CatalogProductOption & {
__typename?: 'CheckboxOption'
/** Indicates the default checked status. */
checkedByDefault: Scalars['Boolean']
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** Contact field */
export type ContactField = {
__typename?: 'ContactField'
/** Store address line. */
address: Scalars['String']
/** Store country. */
country: Scalars['String']
/** Store address type. */
addressType: Scalars['String']
/** Store email. */
email: Scalars['String']
/** Store phone number. */
phone: Scalars['String']
}
/** Custom field */
export type CustomField = {
__typename?: 'CustomField'
/** Custom field id. */
entityId: Scalars['Int']
/** Name of the custom field. */
name: Scalars['String']
/** Value of the custom field. */
value: Scalars['String']
}
/** A connection to a list of items. */
export type CustomFieldConnection = {
__typename?: 'CustomFieldConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<CustomFieldEdge>>>
}
/** An edge in a connection. */
export type CustomFieldEdge = {
__typename?: 'CustomFieldEdge'
/** The item at the end of the edge. */
node: CustomField
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** A customer that shops on a store */
export type Customer = {
__typename?: 'Customer'
/** The ID of the customer. */
entityId: Scalars['Int']
/** The company name of the customer. */
company: Scalars['String']
/** The customer group id of the customer. */
customerGroupId: Scalars['Int']
/** The email address of the customer. */
email: Scalars['String']
/** The first name of the customer. */
firstName: Scalars['String']
/** The last name of the customer. */
lastName: Scalars['String']
/** The notes of the customer. */
notes: Scalars['String']
/** The phone number of the customer. */
phone: Scalars['String']
/** The tax exempt category of the customer. */
taxExemptCategory: Scalars['String']
/** Customer addresses count. */
addressCount: Scalars['Int']
/** Customer attributes count. */
attributeCount: Scalars['Int']
/** Customer store credit. */
storeCredit: Array<Money>
/** Customer attributes. */
attributes: CustomerAttributes
}
/** A custom, store-specific attribute for a customer */
export type CustomerAttribute = {
__typename?: 'CustomerAttribute'
/** The ID of the custom customer attribute */
entityId: Scalars['Int']
/** The value of the custom customer attribute */
value?: Maybe<Scalars['String']>
/** The name of the custom customer attribute */
name: Scalars['String']
}
/** Custom, store-specific customer attributes */
export type CustomerAttributes = {
__typename?: 'CustomerAttributes'
attribute: CustomerAttribute
}
/** Custom, store-specific customer attributes */
export type CustomerAttributesAttributeArgs = {
entityId: Scalars['Int']
}
/** A calendar for allowing selection of a date. */
export type DateFieldOption = CatalogProductOption & {
__typename?: 'DateFieldOption'
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** Date Time Extended */
export type DateTimeExtended = {
__typename?: 'DateTimeExtended'
/** ISO-8601 formatted date in UTC */
utc: Scalars['DateTime']
}
/** Display field */
export type DisplayField = {
__typename?: 'DisplayField'
/** Short date format. */
shortDateFormat: Scalars['String']
/** Extended date format. */
extendedDateFormat: Scalars['String']
}
/** A form allowing selection and uploading of a file from the user's local computer. */
export type FileUploadFieldOption = CatalogProductOption & {
__typename?: 'FileUploadFieldOption'
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** Image */
export type Image = {
__typename?: 'Image'
/** Absolute path to image using store CDN. */
url: Scalars['String']
/** Absolute path to original image using store CDN. */
urlOriginal: Scalars['String']
/** Text description of an image that can be used for SEO and/or accessibility purposes. */
altText: Scalars['String']
/** Indicates whether this is the primary image. */
isDefault: Scalars['Boolean']
}
/** Image */
export type ImageUrlArgs = {
width: Scalars['Int']
height?: Maybe<Scalars['Int']>
}
/** A connection to a list of items. */
export type ImageConnection = {
__typename?: 'ImageConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<ImageEdge>>>
}
/** An edge in a connection. */
export type ImageEdge = {
__typename?: 'ImageEdge'
/** The item at the end of the edge. */
node: Image
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** An inventory */
export type Inventory = {
__typename?: 'Inventory'
/** Locations */
locations: LocationConnection
}
/** An inventory */
export type InventoryLocationsArgs = {
entityIds?: Maybe<Array<Scalars['Int']>>
codes?: Maybe<Array<Scalars['String']>>
typeIds?: Maybe<Array<Scalars['String']>>
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Inventory By Locations */
export type InventoryByLocations = {
__typename?: 'InventoryByLocations'
/** Location id. */
locationEntityId: Scalars['Long']
/** Number of available products in stock. */
availableToSell: Scalars['Long']
/** Indicates a threshold low-stock level. */
warningLevel: Scalars['Int']
/** Indicates whether this product is in stock. */
isInStock: Scalars['Boolean']
}
/** A connection to a list of items. */
export type LocationConnection = {
__typename?: 'LocationConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<LocationEdge>>>
}
/** An edge in a connection. */
export type LocationEdge = {
__typename?: 'LocationEdge'
/** The item at the end of the edge. */
node: InventoryByLocations
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** Logo field */
export type LogoField = {
__typename?: 'LogoField'
/** Logo title. */
title: Scalars['String']
/** Store logo image. */
image: Image
}
/** Measurement */
export type Measurement = {
__typename?: 'Measurement'
/** Unformatted weight measurement value. */
value: Scalars['Float']
/** Unit of measurement. */
unit: Scalars['String']
}
/** A connection to a list of items. */
export type MetafieldConnection = {
__typename?: 'MetafieldConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<MetafieldEdge>>>
}
/** An edge in a connection. */
export type MetafieldEdge = {
__typename?: 'MetafieldEdge'
/** The item at the end of the edge. */
node: Metafields
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.) */
export type Metafields = {
__typename?: 'Metafields'
/** The ID of an object */
id: Scalars['ID']
/** The ID of the metafield when referencing via our backend API. */
entityId: Scalars['Int']
/** A label for identifying a metafield data value. */
key: Scalars['String']
/** A metafield value. */
value: Scalars['String']
}
/** A money object - includes currency code and a money amount */
export type Money = {
__typename?: 'Money'
/** Currency code of the current money. */
currencyCode: Scalars['String']
/** The amount of money. */
value: Scalars['BigDecimal']
}
/** A min and max pair of money objects */
export type MoneyRange = {
__typename?: 'MoneyRange'
/** Minimum money object. */
min: Money
/** Maximum money object. */
max: Money
}
/** A multi-line text input field, aka a text box. */
export type MultiLineTextFieldOption = CatalogProductOption & {
__typename?: 'MultiLineTextFieldOption'
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** An option type that has a fixed list of values. */
export type MultipleChoiceOption = CatalogProductOption & {
__typename?: 'MultipleChoiceOption'
/** The chosen display style for this multiple choice option. */
displayStyle: Scalars['String']
/** List of option values. */
values: ProductOptionValueConnection
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** An option type that has a fixed list of values. */
export type MultipleChoiceOptionValuesArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** A simple multiple choice value comprised of an id and a label. */
export type MultipleChoiceOptionValue = CatalogProductOptionValue & {
__typename?: 'MultipleChoiceOptionValue'
/** Unique ID for the option value. */
entityId: Scalars['Int']
/** Label for the option value. */
label: Scalars['String']
/** Indicates whether this value is the chosen default selected value. */
isDefault: Scalars['Boolean']
}
/** An object with an ID */
export type Node = {
/** The id of the object. */
id: Scalars['ID']
}
/** A single line text input field that only accepts numbers. */
export type NumberFieldOption = CatalogProductOption & {
__typename?: 'NumberFieldOption'
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
}
/** A connection to a list of items. */
export type OptionConnection = {
__typename?: 'OptionConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<OptionEdge>>>
}
/** An edge in a connection. */
export type OptionEdge = {
__typename?: 'OptionEdge'
/** The item at the end of the edge. */
node: ProductOption
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** A connection to a list of items. */
export type OptionValueConnection = {
__typename?: 'OptionValueConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<OptionValueEdge>>>
}
/** An edge in a connection. */
export type OptionValueEdge = {
__typename?: 'OptionValueEdge'
/** The item at the end of the edge. */
node: ProductOptionValue
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
export type OptionValueId = {
optionEntityId: Scalars['Int']
valueEntityId: Scalars['Int']
}
/** Information about pagination in a connection. */
export type PageInfo = {
__typename?: 'PageInfo'
/** When paginating forwards, are there more items? */
hasNextPage: Scalars['Boolean']
/** When paginating backwards, are there more items? */
hasPreviousPage: Scalars['Boolean']
/** When paginating backwards, the cursor to continue. */
startCursor?: Maybe<Scalars['String']>
/** When paginating forwards, the cursor to continue. */
endCursor?: Maybe<Scalars['String']>
}
/** The min and max range of prices that apply to this product. */
export type PriceRanges = {
__typename?: 'PriceRanges'
/** Product price min/max range. */
priceRange: MoneyRange
/** Product retail price min/max range. */
retailPriceRange?: Maybe<MoneyRange>
}
/** The various prices that can be set on a product. */
export type Prices = {
__typename?: 'Prices'
/** Calculated price of the product. */
price: Money
/** Sale price of the product. */
salePrice?: Maybe<Money>
/** Original price of the product. */
basePrice?: Maybe<Money>
/** Retail price of the product. */
retailPrice?: Maybe<Money>
/** Minimum advertised price of the product. */
mapPrice?: Maybe<Money>
/** Product price min/max range. */
priceRange: MoneyRange
/** Product retail price min/max range. */
retailPriceRange?: Maybe<MoneyRange>
/** The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings. */
saved?: Maybe<Money>
/** List of bulk pricing tiers applicable to a product or variant. */
bulkPricing: Array<BulkPricingTier>
}
/** Product */
export type Product = Node & {
__typename?: 'Product'
/** The ID of an object */
id: Scalars['ID']
/** Id of the product. */
entityId: Scalars['Int']
/** Default product variant when no options are selected. */
sku: Scalars['String']
/** Relative URL path to product page. */
path: Scalars['String']
/** Name of the product. */
name: Scalars['String']
/** Description of the product. */
description: Scalars['String']
/** Description of the product in plain text. */
plainTextDescription: Scalars['String']
/** Warranty information of the product. */
warranty: Scalars['String']
/** Minimum purchasable quantity for this product in a single order. */
minPurchaseQuantity?: Maybe<Scalars['Int']>
/** Maximum purchasable quantity for this product in a single order. */
maxPurchaseQuantity?: Maybe<Scalars['Int']>
/** Absolute URL path for adding a product to cart. */
addToCartUrl: Scalars['String']
/** Absolute URL path for adding a product to customer's wishlist. */
addToWishlistUrl: Scalars['String']
/** Prices object determined by supplied product ID, variant ID, and selected option IDs. */
prices?: Maybe<Prices>
/**
* The minimum and maximum price of this product based on variant pricing and/or modifier price rules.
* @deprecated Use priceRanges inside prices node instead.
*/
priceRanges?: Maybe<PriceRanges>
/** Weight of the product. */
weight?: Maybe<Measurement>
/** Height of the product. */
height?: Maybe<Measurement>
/** Width of the product. */
width?: Maybe<Measurement>
/** Depth of the product. */
depth?: Maybe<Measurement>
/** Product options. */
options: OptionConnection
/** Product options. */
productOptions: ProductOptionConnection
/** Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review). */
reviewSummary: Reviews
/** Type of product, ex: physical, digital */
type: Scalars['String']
/**
* The availability state of the product.
* @deprecated Use status inside availabilityV2 instead.
*/
availability: Scalars['String']
/**
* A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
* @deprecated Use description inside availabilityV2 instead.
*/
availabilityDescription: Scalars['String']
/** The availability state of the product. */
availabilityV2: ProductAvailability
/** List of categories associated with the product. */
categories: CategoryConnection
/** Brand associated with the product. */
brand?: Maybe<Brand>
/** Variants associated with the product. */
variants: VariantConnection
/** Custom fields of the product. */
customFields: CustomFieldConnection
/** A list of the images for a product. */
images: ImageConnection
/** Default image for a product. */
defaultImage?: Maybe<Image>
/** Related products for this product. */
relatedProducts: RelatedProductsConnection
/** Inventory information of the product. */
inventory: ProductInventory
/** Metafield data related to a product. */
metafields: MetafieldConnection
/**
* Product creation date
* @deprecated Alpha version. Do not use in production.
*/
createdAt: DateTimeExtended
}
/** Product */
export type ProductPlainTextDescriptionArgs = {
characterLimit?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductPricesArgs = {
includeTax?: Maybe<Scalars['Boolean']>
currencyCode?: Maybe<CurrencyCode>
}
/** Product */
export type ProductPriceRangesArgs = {
includeTax?: Maybe<Scalars['Boolean']>
}
/** Product */
export type ProductOptionsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductProductOptionsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductCategoriesArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductVariantsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
entityIds?: Maybe<Array<Scalars['Int']>>
optionValueIds?: Maybe<Array<OptionValueId>>
}
/** Product */
export type ProductCustomFieldsArgs = {
names?: Maybe<Array<Scalars['String']>>
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductImagesArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductRelatedProductsArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product */
export type ProductMetafieldsArgs = {
namespace: Scalars['String']
keys?: Maybe<Array<Scalars['String']>>
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** Product availability */
export type ProductAvailability = {
/** The availability state of the product. */
status: ProductAvailabilityStatus
/** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
description: Scalars['String']
}
/** Product availability status */
export enum ProductAvailabilityStatus {
Available = 'Available',
Preorder = 'Preorder',
Unavailable = 'Unavailable',
}
/** Available Product */
export type ProductAvailable = ProductAvailability & {
__typename?: 'ProductAvailable'
/** The availability state of the product. */
status: ProductAvailabilityStatus
/** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
description: Scalars['String']
}
/** A connection to a list of items. */
export type ProductConnection = {
__typename?: 'ProductConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<ProductEdge>>>
}
/** An edge in a connection. */
export type ProductEdge = {
__typename?: 'ProductEdge'
/** The item at the end of the edge. */
node: Product
/** A cursor for use in pagination. */
cursor: Scalars['String']
}
/** Product Inventory Information */
export type ProductInventory = {
__typename?: 'ProductInventory'
/** Indicates whether this product is in stock. */
isInStock: Scalars['Boolean']
/** Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart. */
hasVariantInventory: Scalars['Boolean']
/** Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. */
aggregated?: Maybe<AggregatedInventory>
}
/** Product Option */
export type ProductOption = {
__typename?: 'ProductOption'
/** Unique ID for the option. */
entityId: Scalars['Int']
/** Display name for the option. */
displayName: Scalars['String']
/** One of the option values is required to be selected for the checkout. */
isRequired: Scalars['Boolean']
/** Option values. */
values: OptionValueConnection
}
/** Product Option */
export type ProductOptionValuesArgs = {
before?: Maybe<Scalars['String']>
after?: Maybe<Scalars['String']>
first?: Maybe<Scalars['Int']>
last?: Maybe<Scalars['Int']>
}
/** A connection to a list of items. */
export type ProductOptionConnection = {
__typename?: 'ProductOptionConnection'
/** Information to aid in pagination. */
pageInfo: PageInfo
/** A list of edges. */
edges?: Maybe<Array<Maybe<ProductOptionEdge>>>
}
/** An edge in a connection. */