-
Notifications
You must be signed in to change notification settings - Fork 4
/
schema.graphql
3658 lines (3446 loc) · 104 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
# This file was generated based on ".graphqlconfig". Do not edit manually.
schema {
query: Query
mutation: Mutation
}
interface CartAddressInterface {
city: String
company: String
country: CartAddressCountry
customer_notes: String
firstname: String
lastname: String
postcode: String
region: CartAddressRegion
street: [String]
telephone: String
}
interface CartItemInterface {
id: String!
product: ProductInterface!
quantity: Float!
}
"CategoryInterface contains the full set of attributes that can be returned in a category search."
interface CategoryInterface {
available_sort_by: [String]
"Breadcrumbs, parent categories info."
breadcrumbs: [Breadcrumb]
children_count: String
"Timestamp indicating when the category was created."
created_at: 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
"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 which page of results to return. The default value is 1.
currentPage: Int = 1,
#Specifies the maximum number of results to return at once. This attribute is optional.
pageSize: Int = 20,
#Specifies which attribute to sort on, and whether to return the results in ascending or descending order.
sort: ProductSortInput
): 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 CustomizableOptionInterface contains basic information about a customizable option. It can be implemented by several types of configurable options."
interface CustomizableOptionInterface {
"Option ID."
option_id: Int
"Indicates whether the option is required."
required: Boolean
"The order in which the option is displayed."
sort_order: Int
"The display name for this option."
title: String
}
"CustomizableProductInterface contains information about customizable product options."
interface CustomizableProductInterface {
"An array of options for a customizable product."
options: [CustomizableOptionInterface]
}
interface LayerFilterItemInterface {
"Count of items by filter."
items_count: Int
"Filter label."
label: String
"Value for filter request variable to be used in query."
value_string: String
}
"Contains basic information about a product image or video."
interface MediaGalleryInterface {
"The label of the product image or video."
label: String
"The URL of the product image or video."
url: String
}
"PhysicalProductInterface contains attributes specific to tangible products."
interface PhysicalProductInterface {
"The weight of the item, in units defined by the store."
weight: Float
}
"The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes."
interface ProductInterface {
"The attribute set assigned to the product."
attribute_set_id: Int
"Canonical URL."
canonical_url: String
"The categories assigned to a product."
categories: [CategoryInterface]
color: Int
"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
fashion_color: Int
fashion_material: String
fashion_size: Int
fashion_style: String
"Indicates whether a gift message is available."
gift_message_available: String
has_video: Int
"The ID number assigned to the product."
id: Int
"The relative path to the main image on the product page."
image: ProductImage
"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]
"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
"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
"The end date for new product listings."
new_to_date: String
"Product stock only x left count"
only_x_left_in_stock: Float
"If the product has multiple options, determines where they appear on the product page."
options_container: String
"A ProductPrices object, indicating the price of an item."
price: ProductPrices
"An array of ProductLinks objects."
product_links: [ProductLinksInterface]
"Related Products"
related_products: [ProductInterface]
"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
"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
"An array of ProductTierPrices objects."
tier_prices: [ProductTierPrices]
"One of simple, virtual, bundle, downloadable, grouped, or configurable."
type_id: 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
"URL rewrites list"
url_rewrites: [UrlRewrite]
video_file: String
"An array of websites in which the product is available."
websites: [Website]
}
"ProductLinks contains information about linked products, including the link type and product type of each item."
interface ProductLinksInterface {
"One of related, associated, upsell, or crosssell."
link_type: String
"The SKU of the linked product."
linked_product_sku: String
"The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable)."
linked_product_type: String
"The position within the list of product links."
position: Int
"The identifier of the linked product."
sku: String
}
interface SwatchLayerFilterItemInterface {
"Data required to render swatch filter item"
swatch_data: SwatchData
}
type AddConfigurableProductsToCartOutput {
cart: Cart!
}
type AddSimpleProductsToCartOutput {
cart: Cart!
}
type AddVirtualProductsToCartOutput {
cart: Cart!
}
type AppliedCoupon {
code: String!
}
type ApplyCouponToCartOutput {
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
}
"Attribute option."
type AttributeOption {
"Attribute option label."
label: String
"Attribute option value."
value: String
}
type AvailablePaymentMethod {
"The payment method code"
code: String!
"The payment method title."
title: String!
}
type AvailableShippingMethod {
amount: Money!
available: Boolean!
"Could be null if method is not available"
base_amount: Money
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!
}
type BillingCartAddress implements CartAddressInterface {
city: String
company: String
country: CartAddressCountry
customer_notes: String
firstname: String
lastname: String
postcode: String
region: CartAddressRegion
street: [String]
telephone: 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
}
"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
"Indicates the quantity of this specific bundle item."
quantity: Float
}
"BundleProduct defines basic features of a bundle product and contains multiple BundleItems."
type BundleProduct implements CustomizableProductInterface & PhysicalProductInterface & ProductInterface {
"The attribute set assigned to the product."
attribute_set_id: Int
"Canonical URL."
canonical_url: String
"The categories assigned to a product."
categories: [CategoryInterface]
color: Int
"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
fashion_color: Int
fashion_material: String
fashion_size: Int
fashion_style: String
"Indicates whether a gift message is available."
gift_message_available: String
has_video: Int
"The ID number assigned to the product."
id: Int
"The relative path to the main image on the product page."
image: ProductImage
"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]
"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
"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
"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
"A ProductPrices object, indicating the price of an item."
price: ProductPrices
"One of PRICE_RANGE or AS_LOW_AS."
price_view: PriceViewEnum
"An array of ProductLinks objects."
product_links: [ProductLinksInterface]
"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
"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
"An array of ProductTierPrices objects."
tier_prices: [ProductTierPrices]
"One of simple, virtual, bundle, downloadable, grouped, or configurable."
type_id: 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
"URL rewrites list"
url_rewrites: [UrlRewrite]
video_file: String
"An array of websites in which the product is available."
websites: [Website]
"The weight of the item, in units defined by the store."
weight: Float
}
type Cart {
applied_coupon: AppliedCoupon
"Available payment methods"
available_payment_methods: [AvailablePaymentMethod]
billing_address: BillingCartAddress!
email: String
items: [CartItemInterface]
prices: CartPrices
selected_payment_method: SelectedPaymentMethod
shipping_addresses: [ShippingCartAddress]!
}
type CartAddressCountry {
code: String
label: String
}
type CartAddressRegion {
code: String
label: String
}
type CartDiscount {
amount: Money!
label: [String]!
}
type CartItemQuantity {
cart_item_id: Int!
quantity: Float!
}
type CartItemSelectedOptionValuePrice {
type: PriceTypeEnum!
units: String!
value: Float!
}
type CartPrices {
applied_taxes: [CartTaxItem]
discount: CartDiscount
grand_total: Money
subtotal_excluding_tax: Money
subtotal_including_tax: Money
subtotal_with_discount_excluding_tax: Money
}
type CartTaxItem {
amount: Money!
label: 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 {
available_sort_by: [String]
"Breadcrumbs, parent categories info."
breadcrumbs: [Breadcrumb]
"Child categories tree."
children: [CategoryTree]
children_count: String
"Timestamp indicating when the category was created."
created_at: 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
"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 which page of results to return. The default value is 1.
currentPage: Int = 1,
#Specifies the maximum number of results to return at once. This attribute is optional.
pageSize: Int = 20,
#Specifies which attribute to sort on, and whether to return the results in ascending or descending order.
sort: ProductSortInput
): 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
}
"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!
}
"CMS block defines all CMS block information"
type CmsBlock {
"CMS block content"
content: String
"CMS block identifier"
identifier: String
"CMS block title"
title: String
}
"CMS blocks information"
type CmsBlocks {
"An array of CMS blocks"
items: [CmsBlock]
}
"CMS page defines all CMS page information"
type CmsPage {
"CMS page content"
content: String
"CMS page content heading"
content_heading: String
"Identifier of the CMS page"
identifier: String
"CMS page meta description"
meta_description: String
"CMS page meta keywords"
meta_keywords: String
"CMS page meta title"
meta_title: String
"CMS page content heading"
page_layout: String
"CMS page title"
title: String
"URL key of CMS page"
url_key: String
}
type ComplexTextValue {
"HTML format"
html: String!
}
"ConfigurableAttributeOption contains the value_index (and other related information) assigned to a configurable product option"
type ConfigurableAttributeOption {
"The ID assigned to the attribute"
code: String
"A string that describes the configurable attribute option"
label: String
"A unique index number assigned to the configurable product option"
value_index: Int
}
type ConfigurableCartItem implements CartItemInterface {
configurable_options: [SelectedConfigurableOption]!
customizable_options: [SelectedCustomizableOption]!
id: String!
product: ProductInterface!
quantity: Float!
}
"ConfigurableProduct defines basic features of a configurable product and its simple product variants"
type ConfigurableProduct implements CustomizableProductInterface & PhysicalProductInterface & ProductInterface {
"The attribute set assigned to the product."
attribute_set_id: Int
"Canonical URL."
canonical_url: String
"The categories assigned to a product."
categories: [CategoryInterface]
color: Int
"An array of linked simple product items"
configurable_options: [ConfigurableProductOptions]
"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
fashion_color: Int
fashion_material: String
fashion_size: Int
fashion_style: String
"Indicates whether a gift message is available."
gift_message_available: String
has_video: Int
"The ID number assigned to the product."
id: Int
"The relative path to the main image on the product page."
image: ProductImage
"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]
"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
"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
"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
"A ProductPrices object, indicating the price of an item."
price: ProductPrices
"An array of ProductLinks objects."
product_links: [ProductLinksInterface]
"Related Products"
related_products: [ProductInterface]
"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
"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
"An array of ProductTierPrices objects."
tier_prices: [ProductTierPrices]
"One of simple, virtual, bundle, downloadable, grouped, or configurable."
type_id: 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
"URL rewrites list"
url_rewrites: [UrlRewrite]
"An array of variants of products"
variants: [ConfigurableVariant]
video_file: String
"An array of websites in which the product is available."
websites: [Website]
"The weight of the item, in units defined by the store."
weight: Float
}
"ConfigurableProductOptions defines configurable attributes for the specified product"
type ConfigurableProductOptions {
"A string that identifies the attribute"
attribute_code: String
"The ID assigned to the attribute"
attribute_id: String
"The configurable option ID number assigned by the system"
id: Int
"A string that describes the configurable product option, which is displayed on the UI"
label: String
"A number that indicates the order in which the attribute is displayed"
position: Int
"This is the same as a product's id field"
product_id: Int
"Indicates whether the option is the default"
use_default: Boolean
"An array that defines the value_index codes assigned to the configurable product"
values: [ConfigurableProductOptionsValues]
}
"ConfigurableProductOptionsValues contains the index number assigned to a configurable product option"
type ConfigurableProductOptionsValues {
"The label of the product on the default store"
default_label: String
"The label of the product"
label: String
"The label of the product on the current store"
store_label: String
"Indicates whether to use the default_label"
use_default_value: Boolean
"A unique index number assigned to the configurable product option"
value_index: Int
}
"An array containing all the simple product variants of a configurable product"
type ConfigurableVariant {
attributes: [ConfigurableAttributeOption]
product: SimpleProduct
}
type Country {
available_regions: [Region]
full_name_english: String
full_name_locale: String
id: String
three_letter_abbreviation: String
two_letter_abbreviation: String
}
type Currency {
available_currency_codes: [String]
base_currency_code: String
base_currency_symbol: String
default_display_currecy_code: String
default_display_currecy_symbol: String
default_display_currency_code: String
default_display_currency_symbol: String
exchange_rates: [ExchangeRate]
}
"CustomAttributeMetadata defines an array of attribute_codes and entity_types"
type CustomAttributeMetadata {
"An array of attributes"
items: [Attribute]
}
"Customer defines the customer name and address and other details"
type Customer {
"An array containing the customer's shipping and billing addresses"
addresses: [CustomerAddress]
"Timestamp indicating when the account was created"
created_at: String
"The ID assigned to the billing address"
default_billing: String
"The ID assigned to the shipping address"
default_shipping: String
"The customer's date of birth"
dob: String
"The customer's email address. Required"
email: String
"The customer's first name"
firstname: String
"The customer's gender(Male - 1, Female - 2)"
gender: Int
"The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer)"
group_id: Int
"The ID assigned to the customer"
id: Int
"Indicates whether the customer is subscribed to the company's newsletter"
is_subscribed: Boolean
"The customer's family name"
lastname: String
"The customer's middle name"
middlename: String
"An honorific, such as Dr., Mr., or Mrs."
prefix: String
"A value such as Sr., Jr., or III"
suffix: String
"The customer's Tax/VAT number (for corporate customers)"
taxvat: String
}
"CustomerAddress contains detailed information about a customer's billing and shipping addresses"
type CustomerAddress {
"The city or town"
city: String
"The customer's company"
company: String
"The customer's country"
country_id: String
"Address custom attributes"
custom_attributes: [CustomerAddressAttribute]
"The customer ID"
customer_id: Int
"Indicates whether the address is the default billing address"
default_billing: Boolean
"Indicates whether the address is the default shipping address"
default_shipping: Boolean
"Address extension attributes"
extension_attributes: [CustomerAddressAttribute]
"The fax number"
fax: String
"The first name of the person associated with the shipping/billing address"
firstname: String
"The ID assigned to the address object"
id: Int
"The family name of the person associated with the shipping/billing address"
lastname: String
"The middle name of the person associated with the shipping/billing address"
middlename: String
"The customer's ZIP or postal code"
postcode: String
"An honorific, such as Dr., Mr., or Mrs."
prefix: String
"An object containing the region name, region code, and region ID"
region: CustomerAddressRegion
"A number that uniquely identifies the state, province, or other area"
region_id: Int
"An array of strings that define the street number and name"
street: [String]
"A value such as Sr., Jr., or III"
suffix: String
"The telephone number"
telephone: String
"The customer's Tax/VAT number (for corporate customers)"
vat_id: String
}
type CustomerAddressAttribute {
"Attribute code"
attribute_code: String
"Attribute value"
value: String
}
"CustomerAddressRegion defines the customer's state or province"
type CustomerAddressRegion {
"The state or province name"
region: String
"The address region code"
region_code: String
"Uniquely identifies the region"
region_id: Int
}
type CustomerDownloadableProduct {
date: String
download_url: String
order_increment_id: String
remaining_downloads: String
status: String
}
type CustomerDownloadableProducts {
"List of purchased downloadable items"
items: [CustomerDownloadableProduct]
}
"Order mapping fields"
type CustomerOrder {
created_at: String
grand_total: Float
id: Int
increment_id: String
status: String
}
type CustomerOrders {
"Array of orders"
items: [CustomerOrder]
}
type CustomerOutput {
customer: Customer!
}
type CustomerPaymentTokens {
"An array of payment tokens"
items: [PaymentToken]!
}
type CustomerToken {
"The customer token"
token: String
}
"CustomizableAreaOption contains information about a text area that is defined as part of a customizable option."
type CustomizableAreaOption implements CustomizableOptionInterface {
"Option ID."
option_id: Int
"The Stock Keeping Unit of the base product."
product_sku: String
"Indicates whether the option is required."
required: Boolean
"The order in which the option is displayed."
sort_order: Int
"The display name for this option."
title: String
"An object that defines a text area."
value: CustomizableAreaValue
}
"CustomizableAreaValue defines the price and sku of a product whose page contains a customized text area."
type CustomizableAreaValue {
"The maximum number of characters that can be entered for this customizable option."
max_characters: Int
"The price assigned to this option."
price: Float
"FIXED, PERCENT, or DYNAMIC."
price_type: PriceTypeEnum
"The Stock Keeping Unit for this option."
sku: String