-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathschema.graphql
10101 lines (9399 loc) · 315 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 Job {
"Created date time of job in ISO 8601 format."
createdAt: DateTime!
"Job message."
message: String
"Job status."
status: JobStatusEnum!
"Date time of job last update in ISO 8601 format."
updatedAt: DateTime!
}
"An object with an ID"
interface Node {
"The ID of the object."
id: ID!
}
interface ObjectWithMetadata {
"List of publicly stored metadata namespaces."
meta: [MetaStore]! @deprecated(reason : "Use the `metadata` field. This field will be removed after 2020-07-31.")
"List of public metadata items. Can be accessed without permissions."
metadata: [MetadataItem]!
"List of privately stored metadata namespaces."
privateMeta: [MetaStore]! @deprecated(reason : "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
"List of private metadata items.Requires proper staff permissions to access."
privateMetadata: [MetadataItem]!
}
union TranslatableItem = AttributeTranslatableContent | AttributeValueTranslatableContent | CategoryTranslatableContent | CollectionTranslatableContent | MenuItemTranslatableContent | PageTranslatableContent | ProductTranslatableContent | ProductVariantTranslatableContent | SaleTranslatableContent | ShippingMethodTranslatableContent | VoucherTranslatableContent
union _Entity = Address | App | Category | Collection | Group | Product | ProductImage | ProductType | ProductVariant | ServiceAccount | User
"Create a new address for the customer."
type AccountAddressCreate {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user instance for which the address was created."
user: User
}
"Delete an address of the logged-in user."
type AccountAddressDelete {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user instance for which the address was deleted."
user: User
}
"Updates an address of the logged-in user."
type AccountAddressUpdate {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user object for which the address was edited."
user: User
}
"Remove user account."
type AccountDelete {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
user: User
}
type AccountError {
"The error code."
code: AccountErrorCode!
"Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field."
field: String
"The error message."
message: String
}
"Register a new user."
type AccountRegister {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"Informs whether users need to confirm their email address."
requiresConfirmation: Boolean
user: User
}
"Sends an email with the account removal link for the logged-in user."
type AccountRequestDeletion {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Sets a default address for the authenticated user."
type AccountSetDefaultAddress {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"An updated user instance."
user: User
}
"Updates the account of the logged-in user."
type AccountUpdate {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
user: User
}
"Updates metadata of the logged-in user."
type AccountUpdateMeta {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
user: User
}
"Represents user address data."
type Address implements Node {
city: String!
cityArea: String!
companyName: String!
"Shop's default country."
country: CountryDisplay!
countryArea: String!
firstName: String!
"The ID of the object."
id: ID!
"Address is user's default billing address."
isDefaultBillingAddress: Boolean
"Address is user's default shipping address."
isDefaultShippingAddress: Boolean
lastName: String!
phone: String
postalCode: String!
streetAddress1: String!
streetAddress2: String!
}
"Creates user address."
type AddressCreate {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user instance for which the address was created."
user: User
}
"Deletes an address."
type AddressDelete {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user instance for which the address was deleted."
user: User
}
"Sets a default address for the given user."
type AddressSetDefault {
accountErrors: [AccountError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"An updated user instance."
user: User
}
"Updates an address."
type AddressUpdate {
accountErrors: [AccountError!]!
address: Address
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"A user object for which the address was edited."
user: User
}
type AddressValidationData {
addressFormat: String
addressLatinFormat: String
allowedFields: [String]
cityAreaChoices: [ChoiceValue]
cityAreaType: String
cityChoices: [ChoiceValue]
cityType: String
countryAreaChoices: [ChoiceValue]
countryAreaType: String
countryCode: String
countryName: String
postalCodeExamples: [String]
postalCodeMatchers: [String]
postalCodePrefix: String
postalCodeType: String
requiredFields: [String]
upperFields: [String]
}
"Represents allocation."
type Allocation implements Node {
"The ID of the object."
id: ID!
"Quantity allocated for orders."
quantity: Int!
"The warehouse were items were allocated."
warehouse: Warehouse!
}
"Represents app data."
type App implements Node & ObjectWithMetadata {
"Description of this app."
aboutApp: String
"JWT token used to authenticate by thridparty app."
accessToken: String
"Url to iframe with the app."
appUrl: String
"Url to iframe with the configuration for the app."
configurationUrl: String
"The date and time when the app was created."
created: DateTime
"Description of the data privacy defined for this app."
dataPrivacy: String
"Url to details about the privacy policy on the app owner page."
dataPrivacyUrl: String
"Homepage of the app."
homepageUrl: String
"The ID of the object."
id: ID!
"Determine if app will be set active or not."
isActive: Boolean
"List of publicly stored metadata namespaces."
meta: [MetaStore]! @deprecated(reason : "Use the `metadata` field. This field will be removed after 2020-07-31.")
"List of public metadata items. Can be accessed without permissions."
metadata: [MetadataItem]!
"Name of the app."
name: String
"List of the app's permissions."
permissions: [Permission]
"List of privately stored metadata namespaces."
privateMeta: [MetaStore]! @deprecated(reason : "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
"List of private metadata items.Requires proper staff permissions to access."
privateMetadata: [MetadataItem]!
"Support page for the app."
supportUrl: String
"Last 4 characters of the tokens."
tokens: [AppToken]
"Type of the app."
type: AppTypeEnum
"Version number of the app."
version: String
"List of webhooks assigned to this app."
webhooks: [Webhook]
}
"Activate the app."
type AppActivate {
app: App
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
type AppCountableConnection {
edges: [AppCountableEdge!]!
"Pagination data for this connection."
pageInfo: PageInfo!
"A total count of items in the collection."
totalCount: Int
}
type AppCountableEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of the edge."
node: App!
}
"Creates a new app."
type AppCreate {
app: App
appErrors: [AppError!]!
"The newly created authentication token."
authToken: String
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Deactivate the app."
type AppDeactivate {
app: App
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Deletes an app."
type AppDelete {
app: App
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Delete failed installation."
type AppDeleteFailedInstallation {
appErrors: [AppError!]!
appInstallation: AppInstallation
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
type AppError {
"The error code."
code: AppErrorCode!
"Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field."
field: String
"The error message."
message: String
"List of permissions which causes the error."
permissions: [PermissionEnum!]
}
"Fetch and validate manifest."
type AppFetchManifest {
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
manifest: Manifest
}
"Install new app by using app manifest."
type AppInstall {
appErrors: [AppError!]!
appInstallation: AppInstallation
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Represents ongoing installation of app."
type AppInstallation implements Job & Node {
appName: String!
"Created date time of job in ISO 8601 format."
createdAt: DateTime!
"The ID of the object."
id: ID!
manifestUrl: String!
"Job message."
message: String
"Job status."
status: JobStatusEnum!
"Date time of job last update in ISO 8601 format."
updatedAt: DateTime!
}
"Retry failed installation of new app."
type AppRetryInstall {
appErrors: [AppError!]!
appInstallation: AppInstallation
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Represents token data."
type AppToken implements Node {
"Last 4 characters of the token."
authToken: String
"The ID of the object."
id: ID!
"Name of the authenticated token."
name: String
}
"Creates a new token."
type AppTokenCreate {
appErrors: [AppError!]!
appToken: AppToken
"The newly created authentication token."
authToken: String
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Deletes an authentication token assigned to app."
type AppTokenDelete {
appErrors: [AppError!]!
appToken: AppToken
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Verify provided app token."
type AppTokenVerify {
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"Determine if token is valid or not."
valid: Boolean!
}
"Updates an existing app."
type AppUpdate {
app: App
appErrors: [AppError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Assigns storefront's navigation menus."
type AssignNavigation {
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"Assigned navigation menu."
menu: Menu
menuErrors: [MenuError!]!
}
"Custom attribute of a product. Attributes can be assigned to products and variants at the product type level."
type Attribute implements Node & ObjectWithMetadata {
"Whether the attribute can be displayed in the admin product list."
availableInGrid: Boolean!
"Whether the attribute can be filtered in dashboard."
filterableInDashboard: Boolean!
"Whether the attribute can be filtered in storefront."
filterableInStorefront: Boolean!
"The ID of the object."
id: ID!
"The input type to use for entering attribute values in the dashboard."
inputType: AttributeInputTypeEnum
"List of publicly stored metadata namespaces."
meta: [MetaStore]! @deprecated(reason : "Use the `metadata` field. This field will be removed after 2020-07-31.")
"List of public metadata items. Can be accessed without permissions."
metadata: [MetadataItem]!
"Name of an attribute displayed in the interface."
name: String
"List of privately stored metadata namespaces."
privateMeta: [MetaStore]! @deprecated(reason : "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
"List of private metadata items.Requires proper staff permissions to access."
privateMetadata: [MetadataItem]!
productTypes(after: String, before: String, first: Int, last: Int): ProductTypeCountableConnection!
productVariantTypes(after: String, before: String, first: Int, last: Int): ProductTypeCountableConnection!
"Internal representation of an attribute name."
slug: String
"The position of the attribute in the storefront navigation (0 by default)."
storefrontSearchPosition: Int!
"Returns translated attribute fields for the given language code."
translation(
"A language code to return the translation for attribute."
languageCode: LanguageCodeEnum!
): AttributeTranslation
"Whether the attribute requires values to be passed or not."
valueRequired: Boolean!
"List of attribute's values."
values: [AttributeValue]
"Whether the attribute should be visible or not in storefront."
visibleInStorefront: Boolean!
}
"Assign attributes to a given product type."
type AttributeAssign {
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
"The updated product type."
productType: ProductType
}
"Deletes attributes."
type AttributeBulkDelete {
"Returns how many objects were affected."
count: Int!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Clears public metadata item for attribute."
type AttributeClearMeta {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Clears public metadata item for attribute."
type AttributeClearPrivateMeta {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type AttributeCountableConnection {
edges: [AttributeCountableEdge!]!
"Pagination data for this connection."
pageInfo: PageInfo!
"A total count of items in the collection."
totalCount: Int
}
type AttributeCountableEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of the edge."
node: Attribute!
}
"Creates an attribute."
type AttributeCreate {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Deletes an attribute."
type AttributeDelete {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Reorder the values of an attribute."
type AttributeReorderValues {
"Attribute from which values are reordered."
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type AttributeTranslatableContent implements Node {
"Custom attribute of a product."
attribute: Attribute
"The ID of the object."
id: ID!
name: String!
"Returns translated attribute fields for the given language code."
translation(
"A language code to return the translation for attribute."
languageCode: LanguageCodeEnum!
): AttributeTranslation
}
"Creates/Updates translations for attribute."
type AttributeTranslate {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
translationErrors: [TranslationError!]!
}
type AttributeTranslation implements Node {
"The ID of the object."
id: ID!
"Translation language."
language: LanguageDisplay!
name: String!
}
"Un-assign attributes from a given product type."
type AttributeUnassign {
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
"The updated product type."
productType: ProductType
}
"Updates attribute."
type AttributeUpdate {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Update public metadata for attribute."
type AttributeUpdateMeta {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Update public metadata for attribute."
type AttributeUpdatePrivateMeta {
attribute: Attribute
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Represents a value of an attribute."
type AttributeValue implements Node {
"The ID of the object."
id: ID!
"The input type to use for entering attribute values in the dashboard."
inputType: AttributeInputTypeEnum
"Name of a value displayed in the interface."
name: String
"Internal representation of a value (unique per attribute)."
slug: String
"Returns translated attribute value fields for the given language code."
translation(
"A language code to return the translation for attribute value."
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
"Type of value (used only when `value` field is set)."
type: AttributeValueType @deprecated(reason : "Use the `inputType` field to determine the type of attribute's value. This field will be removed after 2020-07-31.")
}
"Deletes values of attributes."
type AttributeValueBulkDelete {
"Returns how many objects were affected."
count: Int!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Creates a value for an attribute."
type AttributeValueCreate {
"The updated attribute."
attribute: Attribute
attributeValue: AttributeValue
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Deletes a value of an attribute."
type AttributeValueDelete {
"The updated attribute."
attribute: Attribute
attributeValue: AttributeValue
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type AttributeValueTranslatableContent implements Node {
"Represents a value of an attribute."
attributeValue: AttributeValue
"The ID of the object."
id: ID!
name: String!
"Returns translated attribute value fields for the given language code."
translation(
"A language code to return the translation for attribute value."
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
}
"Creates/Updates translations for attribute value."
type AttributeValueTranslate {
attributeValue: AttributeValue
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
translationErrors: [TranslationError!]!
}
type AttributeValueTranslation implements Node {
"The ID of the object."
id: ID!
"Translation language."
language: LanguageDisplay!
name: String!
}
"Updates value of an attribute."
type AttributeValueUpdate {
"The updated attribute."
attribute: Attribute
attributeValue: AttributeValue
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type AuthorizationKey {
"Authorization key (client ID)."
key: String!
"Name of the authorization backend."
name: AuthorizationKeyType!
}
"Adds an authorization key."
type AuthorizationKeyAdd {
"Newly added authorization key."
authorizationKey: AuthorizationKey
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"Updated shop."
shop: Shop
shopErrors: [ShopError!]!
}
"Deletes an authorization key."
type AuthorizationKeyDelete {
"Authorization key that was deleted."
authorizationKey: AuthorizationKey
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
"Updated shop."
shop: Shop
shopErrors: [ShopError!]!
}
type BulkProductError {
"List of attributes IDs which causes the error."
attributes: [ID!]
"The error code."
code: ProductErrorCode!
"Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field."
field: String
"Index of an input list item that caused the error."
index: Int
"The error message."
message: String
"List of warehouse IDs which causes the error."
warehouses: [ID!]
}
type BulkStockError {
"List of attributes IDs which causes the error."
attributes: [ID!]
"The error code."
code: ProductErrorCode!
"Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field."
field: String
"Index of an input list item that caused the error."
index: Int
"The error message."
message: String
}
"Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront."
type Category implements Node & ObjectWithMetadata {
"List of ancestors of the category."
ancestors(
"Return the elements in the list that come after the specified cursor."
after: String,
"Return the elements in the list that come before the specified cursor."
before: String,
"Return the first n elements from the list."
first: Int,
"Return the last n elements from the list."
last: Int
): CategoryCountableConnection
backgroundImage(
"Size of the image."
size: Int
): Image
"List of children of the category."
children(
"Return the elements in the list that come after the specified cursor."
after: String,
"Return the elements in the list that come before the specified cursor."
before: String,
"Return the first n elements from the list."
first: Int,
"Return the last n elements from the list."
last: Int
): CategoryCountableConnection
description: String!
descriptionJson: JSONString!
"The ID of the object."
id: ID!
level: Int!
"List of publicly stored metadata namespaces."
meta: [MetaStore]! @deprecated(reason : "Use the `metadata` field. This field will be removed after 2020-07-31.")
"List of public metadata items. Can be accessed without permissions."
metadata: [MetadataItem]!
name: String!
parent: Category
"List of privately stored metadata namespaces."
privateMeta: [MetaStore]! @deprecated(reason : "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
"List of private metadata items.Requires proper staff permissions to access."
privateMetadata: [MetadataItem]!
"List of products in the category."
products(
"Return the elements in the list that come after the specified cursor."
after: String,
"Return the elements in the list that come before the specified cursor."
before: String,
"Return the first n elements from the list."
first: Int,
"Return the last n elements from the list."
last: Int
): ProductCountableConnection
seoDescription: String
seoTitle: String
slug: String!
"Returns translated category fields for the given language code."
translation(
"A language code to return the translation for category."
languageCode: LanguageCodeEnum!
): CategoryTranslation
"The storefront's URL for the category."
url: String @deprecated(reason : "This field will be removed after 2020-07-31.")
}
"Deletes categories."
type CategoryBulkDelete {
"Returns how many objects were affected."
count: Int!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Clears public metadata for category."
type CategoryClearMeta {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Clears private metadata for category."
type CategoryClearPrivateMeta {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type CategoryCountableConnection {
edges: [CategoryCountableEdge!]!
"Pagination data for this connection."
pageInfo: PageInfo!
"A total count of items in the collection."
totalCount: Int
}
type CategoryCountableEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of the edge."
node: Category!
}
"Creates a new category."
type CategoryCreate {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Deletes a category."
type CategoryDelete {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
type CategoryTranslatableContent implements Node {
"Represents a single category of products."
category: Category
description: String!
descriptionJson: JSONString!
"The ID of the object."
id: ID!
name: String!
seoDescription: String
seoTitle: String
"Returns translated category fields for the given language code."
translation(
"A language code to return the translation for category."
languageCode: LanguageCodeEnum!
): CategoryTranslation
}
"Creates/Updates translations for Category."
type CategoryTranslate {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
translationErrors: [TranslationError!]!
}
type CategoryTranslation implements Node {
description: String!
descriptionJson: JSONString!
"The ID of the object."
id: ID!
"Translation language."
language: LanguageDisplay!
name: String!
seoDescription: String
seoTitle: String
}
"Updates a category."
type CategoryUpdate {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Update public metadata for category."
type CategoryUpdateMeta {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Update private metadata for category."
type CategoryUpdatePrivateMeta {
category: Category
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
productErrors: [ProductError!]!
}
"Checkout object."
type Checkout implements Node & ObjectWithMetadata {
"List of available payment gateways."
availablePaymentGateways: [PaymentGateway!]!
"Shipping methods that can be used with this order."
availableShippingMethods: [ShippingMethod]!
billingAddress: Address
created: DateTime!
discount: Money
discountName: String
"Email of a customer."
email: String!
"List of gift cards associated with this checkout."
giftCards: [GiftCard]
"The ID of the object."
id: ID!
"Returns True, if checkout requires shipping."
isShippingRequired: Boolean!
lastChange: DateTime!
"A list of checkout lines, each containing information about an item in the checkout."
lines: [CheckoutLine]
"List of publicly stored metadata namespaces."
meta: [MetaStore]! @deprecated(reason : "Use the `metadata` field. This field will be removed after 2020-07-31.")
"List of public metadata items. Can be accessed without permissions."
metadata: [MetadataItem]!
note: String!
"List of privately stored metadata namespaces."
privateMeta: [MetaStore]! @deprecated(reason : "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
"List of private metadata items.Requires proper staff permissions to access."
privateMetadata: [MetadataItem]!
quantity: Int!
shippingAddress: Address
shippingMethod: ShippingMethod
"The price of the shipping, with all the taxes included."
shippingPrice: TaxedMoney
"The price of the checkout before shipping, with taxes included."
subtotalPrice: TaxedMoney
"The checkout's token."
token: UUID!
"The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included."
totalPrice: TaxedMoney
translatedDiscountName: String
user: User
voucherCode: String
}
"Adds a gift card or a voucher to a checkout."
type CheckoutAddPromoCode {
"The checkout with the added gift card or voucher."
checkout: Checkout
checkoutErrors: [CheckoutError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Update billing address in the existing checkout."
type CheckoutBillingAddressUpdate {
"An updated checkout."
checkout: Checkout
checkoutErrors: [CheckoutError!]!
"List of errors that occurred executing the mutation."
errors: [Error!]! @deprecated(reason : "Use typed errors with error codes. This field will be removed after 2020-07-31.")
}
"Clear metadata for checkout."
type CheckoutClearMeta {
checkout: Checkout
checkoutErrors: [CheckoutError!]!
"List of errors that occurred executing the mutation."