-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.graphql
6572 lines (5049 loc) · 158 KB
/
schema.graphql
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
# source: https://stagingm232-na.coravin.com/graphql
# timestamp: Wed May 13 2020 11:56:38 GMT-0400 (Eastern Daylight Time)
input AddBundleProductsToCartInput {
cart_id: String!
cart_items: [BundleProductCartItemInput]!
}
type AddBundleProductsToCartOutput {
cart: Cart!
}
input AddConfigurableProductsToCartInput {
cart_id: String!
cart_items: [ConfigurableProductCartItemInput]!
}
type AddConfigurableProductsToCartOutput {
cart: Cart!
}
input AddDownloadableProductsToCartInput {
cart_id: String!
cart_items: [DownloadableProductCartItemInput]!
}
type AddDownloadableProductsToCartOutput {
cart: Cart!
}
input AddSimpleProductsToCartInput {
cart_id: String!
cart_items: [SimpleProductCartItemInput]!
}
type AddSimpleProductsToCartOutput {
cart: Cart!
}
input AddVirtualProductsToCartInput {
cart_id: String!
cart_items: [VirtualProductCartItemInput]!
}
type AddVirtualProductsToCartOutput {
cart: Cart!
}
"""
A bucket that contains information for each filterable option (such as price, category ID, and custom attributes).
"""
type Aggregation {
"""Attribute code of the aggregation group."""
attribute_code: String!
"""The number of options in the aggregation group."""
count: Int
"""The aggregation display name."""
label: String
"""Array of options for the aggregation."""
options: [AggregationOption]
}
type AggregationOption implements AggregationOptionInterface {
"""The number of items that match the aggregation option."""
count: Int
"""Aggregation option display label."""
label: String
"""The internal ID that represents the value of the option."""
value: String!
}
interface AggregationOptionInterface {
"""The number of items that match the aggregation option."""
count: Int
"""Aggregation option display label."""
label: String
"""The internal ID that represents the value of the option."""
value: String!
}
type AppliedCoupon {
code: String!
}
"""Contains the applied gift card with applied and remaining balance"""
type AppliedGiftCard {
"""Applied balance to the current cart"""
applied_balance: Money
"""Gift card account code"""
code: String
"""Current balance remaining on gift card"""
current_balance: Money
"""Gift card expiration date"""
expiration_date: String
}
"""Applied and current balance"""
type AppliedStoreCredit {
"""Applied store credit balance to the current cart"""
applied_balance: Money
"""Current balance remaining on store credit"""
current_balance: Money
"""
Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned
"""
enabled: Boolean
}
input ApplyCouponToCartInput {
cart_id: String!
coupon_code: String!
}
type ApplyCouponToCartOutput {
cart: Cart!
}
"""Defines the input required to run the applyGiftCardToCart mutation"""
input ApplyGiftCardToCartInput {
"""The unique ID that identifies the customer's cart"""
cart_id: String!
"""The gift card code to be applied to the cart"""
gift_card_code: String!
}
"""Defines the possible output for the applyGiftCardToCart mutation"""
type ApplyGiftCardToCartOutput {
"""Describes the contents of the specified shopping cart"""
cart: Cart!
}
"""Defines the input required to run the applyStoreCreditToCart mutation"""
input ApplyStoreCreditToCartInput {
"""The unique ID that identifies the customer's cart"""
cart_id: String!
}
"""Defines the possible output for the applyStoreCreditToCart mutation"""
type ApplyStoreCreditToCartOutput {
"""Describes the contents of the specified shopping cart"""
cart: Cart!
}
"""
Attribute contains the attribute_type of the specified attribute_code and entity_type
"""
type Attribute {
"""
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
"""
attribute_code: String
"""Attribute options list."""
attribute_options: [AttributeOption]
"""The data type of the attribute"""
attribute_type: String
"""The type of entity that defines the attribute"""
entity_type: String
"""The frontend input type of the attribute"""
input_type: String
}
"""AttributeInput specifies the attribute_code and entity_type to search"""
input AttributeInput {
"""
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
"""
attribute_code: String
"""The type of entity that defines the attribute"""
entity_type: String
}
"""Attribute option."""
type AttributeOption {
"""Attribute option label."""
label: String
"""Attribute option value."""
value: String
}
input AuthorizenetInput {
"""The last four digits of the credit or debit card"""
cc_last_4: Int!
"""Authorize.Net's description of the transaction request"""
opaque_data_descriptor: String!
"""The nonce returned by Authorize.Net"""
opaque_data_value: String!
}
type AvailablePaymentMethod {
"""The payment method code"""
code: String!
"""The payment method title."""
title: String!
}
type AvailableShippingMethod {
amount: Money!
available: Boolean!
base_amount: Money @deprecated(reason: "The field should not be used on the storefront")
carrier_code: String!
carrier_title: String!
error_message: String
"""Could be null if method is not available"""
method_code: String
"""Could be null if method is not available"""
method_title: String
price_excl_tax: Money!
price_incl_tax: Money!
}
input BillingAddressInput {
address: CartAddressInput
customer_address_id: Int
"""Set billing address same as shipping"""
same_as_shipping: Boolean
"""Deprecated: use `same_as_shipping` field instead"""
use_for_shipping: Boolean
}
type BillingCartAddress implements CartAddressInterface {
city: String!
company: String
country: CartAddressCountry!
customer_notes: String @deprecated(reason: "The field is used only in shipping address")
firstname: String!
lastname: String!
postcode: String
region: CartAddressRegion
street: [String]!
telephone: String!
}
input BraintreeCcVaultInput {
device_data: String
public_hash: String!
}
input BraintreeInput {
"""
Contains a fingerprint provided by Braintree JS SDK and should be sent with
sale transaction details to the Braintree payment gateway. Should be specified
only in a case if Kount (advanced fraud protection) is enabled for Braintree
payment integration.
"""
device_data: String
"""
States whether an entered by a customer credit/debit card should be tokenized
for later usage. Required only if Vault is enabled for Braintree payment integration.
"""
is_active_payment_token_enabler: Boolean!
"""
The one-time payment token generated by Braintree payment gateway based on
card details. Required field to make sale transaction.
"""
payment_method_nonce: String!
}
"""Breadcrumb item."""
type Breadcrumb {
"""Category ID."""
category_id: Int
"""Category level."""
category_level: Int
"""Category name."""
category_name: String
"""Category URL key."""
category_url_key: String
"""Category URL path."""
category_url_path: String
}
type BundleCartItem implements CartItemInterface {
bundle_options: [SelectedBundleOption]!
customizable_options: [SelectedCustomizableOption]!
id: String!
prices: CartItemPrices
product: ProductInterface!
quantity: Float!
}
"""BundleItem defines an individual item in a bundle product."""
type BundleItem {
"""An ID assigned to each type of item in a bundle product."""
option_id: Int
"""An array of additional options for this bundle item."""
options: [BundleItemOption]
"""he relative position of this item compared to the other bundle items."""
position: Int
"""Indicates whether the item must be included in the bundle."""
required: Boolean
"""The SKU of the bundle product."""
sku: String
"""The display name of the item."""
title: String
"""
The input type that the customer uses to select the item. Examples include radio button and checkbox.
"""
type: String
}
"""
BundleItemOption defines characteristics and options for a specific bundle item.
"""
type BundleItemOption {
"""
Indicates whether the customer can change the number of items for this option.
"""
can_change_quantity: Boolean
"""The ID assigned to the bundled item option."""
id: Int
"""Indicates whether this option is the default option."""
is_default: Boolean
"""The text that identifies the bundled item option."""
label: String
"""
When a bundle item contains multiple options, the relative position of this option compared to the other options.
"""
position: Int
"""The price of the selected option."""
price: Float
"""One of FIXED, PERCENT, or DYNAMIC."""
price_type: PriceTypeEnum
"""Contains details about this product option."""
product: ProductInterface
"""Indicates the quantity of this specific bundle item."""
qty: Float @deprecated(reason: "The `qty` is deprecated. Use `quantity` instead.")
"""Indicates the quantity of this specific bundle item."""
quantity: Float
}
input BundleOptionInput {
id: Int!
quantity: Float!
value: [String]!
}
"""
BundleProduct defines basic features of a bundle product and contains multiple BundleItems.
"""
type BundleProduct implements ProductInterface & PhysicalProductInterface & CustomizableProductInterface {
"""The attribute set assigned to the product."""
attribute_set_id: Int
"""
Relative canonical URL. This value is returned only if the system setting 'Use
Canonical Link Meta Tag For Products' is enabled
"""
canonical_url: String
capsules: Int
"""The categories assigned to a product."""
categories: [CategoryInterface]
color: String
coravin_at_a_glance: String
coravin_autodelivery: String
coravin_compare: String
coravin_comparison_chart: String
coravin_custom_info: String
coravin_demooz: String
coravin_exclusive: String
coravin_faqs: String
coravin_features: String
coravin_getting_started: String
coravin_market: String
coravin_powerreviews_id: String
coravin_tech_specs: String
coravin_usage_tips: String
coravin_why_capsules: String
"""The product's country of origin."""
country_of_manufacture: String
"""Timestamp indicating when the product was created."""
created_at: String
"""Crosssell Products"""
crosssell_products: [ProductInterface]
"""
Detailed information about the product. The value can include simple HTML tags.
"""
description: ComplexTextValue
"""Indicates whether the bundle product has a dynamic price."""
dynamic_price: Boolean
"""Indicates whether the bundle product has a dynamic SK."""
dynamic_sku: Boolean
"""
Indicates whether the bundle product has a dynamically calculated weight.
"""
dynamic_weight: Boolean
"""Indicates whether a gift message is available."""
gift_message_available: String
"""The ID number assigned to the product."""
id: Int
"""The relative path to the main image on the product page."""
image: ProductImage
is_featured: Int
"""Indicates whether the product can be returned"""
is_returnable: String
"""An array containing information about individual bundle items."""
items: [BundleItem]
"""A number representing the product's manufacturer."""
manufacturer: Int
"""An array of Media Gallery objects."""
media_gallery: [MediaGalleryInterface]
"""An array of MediaGalleryEntry objects."""
media_gallery_entries: [MediaGalleryEntry] @deprecated(reason: "Use product's `media_gallery` instead")
"""
A brief overview of the product for search results listings, maximum 255 characters.
"""
meta_description: String
"""
A comma-separated list of keywords that are visible only to search engines.
"""
meta_keyword: String
"""
A string that is displayed in the title bar and tab of the browser and in search results lists.
"""
meta_title: String
mirakl_mcm_is_operator_master: Int
mirakl_mcm_product_id: String
mirakl_offer_state_ids: String
mirakl_shop_ids: String
mirakl_sync: Int
"""The product name. Customers use this name to identify the product."""
name: String
"""
The beginning date for new product listings, and determines if the product is featured as a new product.
"""
new_from_date: String
new_product: Int
"""The end date for new product listings."""
new_to_date: String
"""Product stock only x left count"""
only_x_left_in_stock: Float
"""An array of options for a customizable product."""
options: [CustomizableOptionInterface]
"""
If the product has multiple options, determines where they appear on the product page.
"""
options_container: String
persona: String
pr_asin: String
"""A ProductPrices object, indicating the price of an item."""
price: ProductPrices @deprecated(reason: "Use price_range for product price information.")
"""A PriceRange object, indicating the range of prices for the product"""
price_range: PriceRange!
"""An array of TierPrice objects."""
price_tiers: [TierPrice]
"""One of PRICE_RANGE or AS_LOW_AS."""
price_view: PriceViewEnum
product_family: String
"""An array of ProductLinks objects."""
product_links: [ProductLinksInterface]
product_sort_order: String
"""Related Products"""
related_products: [ProductInterface]
"""Indicates whether to ship bundle items together or individually."""
ship_bundle_items: ShipBundleItemsEnum
"""A short description of the product. Its use depends on the theme."""
short_description: ComplexTextValue
"""
A number or code assigned to a product to identify the product, options, price, and manufacturer.
"""
sku: String
"""The relative path to the small image, which is used on catalog pages."""
small_image: ProductImage
"""The beginning date that a product has a special price."""
special_from_date: String
"""The discounted price of the product."""
special_price: Float
"""The end date that a product has a special price."""
special_to_date: String
"""Stock status of the product"""
stock_status: ProductStockStatus
style: String
"""The file name of a swatch image"""
swatch_image: String
"""The relative path to the product's thumbnail image."""
thumbnail: ProductImage
"""
The price when tier pricing is in effect and the items purchased threshold has been reached.
"""
tier_price: Float @deprecated(reason: "Use price_tiers for product tier price information.")
"""An array of ProductTierPrices objects."""
tier_prices: [ProductTierPrices] @deprecated(reason: "Use price_tiers for product tier price information.")
"""
One of simple, virtual, bundle, downloadable, grouped, or configurable.
"""
type_id: String @deprecated(reason: "Use __typename instead.")
type_of_product: Int
upc_code: String
"""Timestamp indicating when the product was updated."""
updated_at: String
"""Upsell Products"""
upsell_products: [ProductInterface]
"""The part of the URL that identifies the product"""
url_key: String
url_path: String @deprecated(reason: "Use product's `canonical_url` or url rewrites instead")
"""URL rewrites list"""
url_rewrites: [UrlRewrite]
"""The part of the product URL that is appended after the url key"""
url_suffix: String
"""An array of websites in which the product is available."""
websites: [Website] @deprecated(reason: "The field should not be used on the storefront.")
"""The weight of the item, in units defined by the store."""
weight: Float
}
input BundleProductCartItemInput {
bundle_options: [BundleOptionInput]!
customizable_options: [CustomizableOptionInput]
data: CartItemInput!
}
type Cart {
"""An array of coupons that have been applied to the cart"""
applied_coupon: AppliedCoupon @deprecated(reason: "Use applied_coupons instead ")
"""
An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code
"""
applied_coupons: [AppliedCoupon]
"""
Contains the code attribute, which specifies the applied gift card codes
"""
applied_gift_cards: [AppliedGiftCard]
"""Contains store credit information applied on the cart"""
applied_store_credit: AppliedStoreCredit
"""Available payment methods"""
available_payment_methods: [AvailablePaymentMethod]
billing_address: BillingCartAddress
email: String
"""The ID of the cart."""
id: ID!
is_virtual: Boolean!
items: [CartItemInterface]
prices: CartPrices
selected_payment_method: SelectedPaymentMethod
shipping_addresses: [ShippingCartAddress]!
total_quantity: Float!
}
type CartAddressCountry {
code: String!
label: String!
}
input CartAddressInput {
city: String!
company: String
country_code: String!
firstname: String!
lastname: String!
postcode: String
region: String
save_in_address_book: Boolean
street: [String]!
telephone: String!
}
interface CartAddressInterface {
city: String!
company: String
country: CartAddressCountry!
firstname: String!
lastname: String!
postcode: String
region: CartAddressRegion
street: [String]!
telephone: String!
}
type CartAddressRegion {
code: String!
label: String!
}
type CartDiscount {
amount: Money!
label: [String]!
}
input CartItemInput {
quantity: Float!
sku: String!
}
interface CartItemInterface {
id: String!
prices: CartItemPrices
product: ProductInterface!
quantity: Float!
}
type CartItemPrices {
"""An array of discounts to be applied to the cart item"""
discounts: [Discount]
price: Money!
row_total: Money!
row_total_including_tax: Money!
"""The total of all discounts applied to the item"""
total_item_discount: Money
}
"""
Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`
"""
type CartItemQuantity {
cart_item_id: Int! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`")
quantity: Float! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`")
}
type CartItemSelectedOptionValuePrice {
type: PriceTypeEnum!
units: String!
value: Float!
}
input CartItemUpdateInput {
cart_item_id: Int!
customizable_options: [CustomizableOptionInput]
quantity: Float
}
type CartPrices {
applied_taxes: [CartTaxItem]
discount: CartDiscount @deprecated(reason: "Use discounts instead ")
"""An array of applied discounts"""
discounts: [Discount]
grand_total: Money
subtotal_excluding_tax: Money
subtotal_including_tax: Money
subtotal_with_discount_excluding_tax: Money
}
type CartTaxItem {
amount: Money!
label: String!
}
"""
CategoryFilterInput defines the filters to be used in the search. A filter
contains at least one attribute, a comparison operator, and the value that is
being searched for.
"""
input CategoryFilterInput {
"""Filter by category ID that uniquely identifies the category."""
ids: FilterEqualTypeInput
"""Filter by the display name of the category."""
name: FilterMatchTypeInput
"""Filter by the part of the URL that identifies the category"""
url_key: FilterEqualTypeInput
}
"""
CategoryInterface contains the full set of attributes that can be returned in a category search.
"""
interface CategoryInterface {
affirm_category_mfp: String
affirm_category_mfp_end_date: String
affirm_category_mfp_priority: Int
affirm_category_mfp_start_date: String
affirm_category_mfp_type: Int
affirm_category_promo_id: String
automatic_sorting: String
available_sort_by: [String]
"""Breadcrumbs, parent categories info."""
breadcrumbs: [Breadcrumb]
"""
Relative canonical URL. This value is returned only if the system setting 'Use
Canonical Link Meta Tag For Categories' is enabled
"""
canonical_url: String
children_count: String
"""Category CMS Block."""
cms_block: CmsBlock
"""Timestamp indicating when the category was created."""
created_at: String
custom_layout_update_file: String
"""The attribute to use for sorting."""
default_sort_by: String
"""An optional description of the category."""
description: String
display_mode: String
filter_price_range: Float
"""An ID that uniquely identifies the category."""
id: Int
image: String
include_in_menu: Int
is_anchor: Int
landing_page: Int
"""Indicates the depth of the category within the tree."""
level: Int
meta_description: String
meta_keywords: String
meta_title: String
mirakl_attr_set_id: Int
mirakl_sync: Int
"""The display name of the category."""
name: String
"""Category Path."""
path: String
"""Category path in store."""
path_in_store: String
"""
The position of the category relative to other categories at the same level in tree.
"""
position: Int
"""The number of products in the category."""
product_count: Int
"""The list of products assigned to the category."""
products(
"""
Specifies the maximum number of results to return at once. This attribute is optional.
"""
pageSize: Int = 20
"""Specifies which page of results to return. The default value is 1."""
currentPage: Int = 1
"""
Specifies which attributes to sort on, and whether to return the results in ascending or descending order.
"""
sort: ProductAttributeSortInput
): CategoryProducts
"""Timestamp indicating when the category was updated."""
updated_at: String
"""The url key assigned to the category."""
url_key: String
"""The url path assigned to the category."""
url_path: String
"""The part of the category URL that is appended after the url key"""
url_suffix: String
}
"""The category products object returned in the Category query."""
type CategoryProducts {
"""An array of products that are assigned to the category."""
items: [ProductInterface]
"""
An object that includes the page_info and currentPage values specified in the query.
"""
page_info: SearchResultPageInfo
"""The number of products returned."""
total_count: Int
}
"""Category Tree implementation."""
type CategoryTree implements CategoryInterface {
affirm_category_mfp: String
affirm_category_mfp_end_date: String
affirm_category_mfp_priority: Int
affirm_category_mfp_start_date: String
affirm_category_mfp_type: Int
affirm_category_promo_id: String
automatic_sorting: String
available_sort_by: [String]
"""Breadcrumbs, parent categories info."""
breadcrumbs: [Breadcrumb]
"""
Relative canonical URL. This value is returned only if the system setting 'Use
Canonical Link Meta Tag For Categories' is enabled
"""
canonical_url: String
"""Child categories tree."""
children: [CategoryTree]
children_count: String
"""Category CMS Block."""
cms_block: CmsBlock
"""Timestamp indicating when the category was created."""
created_at: String
custom_layout_update_file: String
"""The attribute to use for sorting."""
default_sort_by: String
"""An optional description of the category."""
description: String
display_mode: String
filter_price_range: Float
"""An ID that uniquely identifies the category."""
id: Int
image: String
include_in_menu: Int
is_anchor: Int
landing_page: Int
"""Indicates the depth of the category within the tree."""
level: Int
meta_description: String
meta_keywords: String
meta_title: String
mirakl_attr_set_id: Int
mirakl_sync: Int
"""The display name of the category."""
name: String
"""Category Path."""
path: String
"""Category path in store."""
path_in_store: String
"""
The position of the category relative to other categories at the same level in tree.
"""
position: Int
"""The number of products in the category."""
product_count: Int
"""The list of products assigned to the category."""
products(
"""
Specifies the maximum number of results to return at once. This attribute is optional.
"""
pageSize: Int = 20
"""Specifies which page of results to return. The default value is 1."""
currentPage: Int = 1
"""
Specifies which attributes to sort on, and whether to return the results in ascending or descending order.
"""
sort: ProductAttributeSortInput
): CategoryProducts
"""Timestamp indicating when the category was updated."""
updated_at: String
"""The url key assigned to the category."""
url_key: String
"""The url path assigned to the category."""
url_path: String
"""The part of the category URL that is appended after the url key"""
url_suffix: String
}
"""Defines all Checkout Agreement information"""
type CheckoutAgreement {
"""Checkout Agreement identifier"""
agreement_id: Int!
"""Checkout Agreement checkbox text"""
checkbox_text: String!
"""Checkout Agreement content"""
content: String!
"""Checkout Agreement content height"""
content_height: String
"""Is Checkout Agreement content in HTML format"""
is_html: Boolean!
mode: CheckoutAgreementMode!
"""Checkout Agreement name"""
name: String!
}
enum CheckoutAgreementMode {
AUTO
MANUAL
}
"""CMS block defines all CMS block information"""
type CmsBlock {
"""CMS block content"""
content: String