This repository has been archived by the owner on Apr 14, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
shopify-admin.graphql
22592 lines (17178 loc) · 583 KB
/
shopify-admin.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
# 2020-04
schema {
query: QueryRoot
mutation: Mutation
}
"""
Represents the access scope permission that is applicable to a merchant's shop, such as `read_orders`.
"""
type AccessScope {
"""Description of the access scopes enabled on an api permission."""
description: String!
"""A human-friendly string for an access scope."""
handle: String!
}
"""Whether all items in the cart are entitled to the discount."""
type AllDiscountItems {
"""Whether all items are selected. The value is hardcoded to `true`."""
allItems: Boolean!
}
"""A version of the API."""
type ApiVersion {
"""The human-readable name of the version."""
displayName: String!
"""
The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.
"""
handle: String!
"""Whether the version is supported by Shopify."""
supported: Boolean!
}
"""A Shopify application."""
type App implements Node {
"""A unique application API identifier."""
apiKey: String!
"""App store page URL of the app."""
appStoreAppUrl: URL
"""App store page URL of the developer who created the app."""
appStoreDeveloperUrl: URL
"""Banner image for the app."""
banner: Image!
"""Description of the app."""
description: String
"""App's developer name."""
developerName: String
"""Website of the developer who created the app."""
developerUrl: URL! @deprecated(reason: "Use `appStoreDeveloperUrl` instead")
"""Whether the app uses the Embedded App SDK."""
embedded: Boolean!
"""Requirements that must be met before the app can be installed."""
failedRequirements: [FailedRequirement!]!
"""List of app features."""
features: [String!]!
"""Feedback from this app about the store."""
feedback: AppFeedback
"""Handle of the app."""
handle: String
"""Icon that represents the app."""
icon: Image!
"""Globally unique identifier."""
id: ID!
"""Webpage where you can install the app."""
installUrl: URL
"""
Corresponding AppInstallation for this shop and App.
Returns null if the App is not installed.
"""
installation: AppInstallation
"""Webpage that the app starts in."""
launchUrl: URL! @deprecated(reason: "Use AppInstallation.launchUrl instead")
"""
Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.
"""
navigationItems: [NavigationItem!]! @deprecated(reason: "Use AppInstallation.navigationItems instead")
"""Detailed information about the app pricing."""
pricingDetails: String
"""Summary of the app pricing details."""
pricingDetailsSummary: String!
"""Link to app privacy policy."""
privacyPolicyUrl: URL
"""Whether the app is published."""
published: Boolean!
"""Screenshots of the app."""
screenshots: [Image!]!
"""Whether the app was developed by Shopify."""
shopifyDeveloped: Boolean!
"""Name of the app."""
title: String!
"""
Message that appears when the app is uninstalled. For example:
By removing this app, you will no longer be able to publish products to
MySocialSite or view this app in your Shopify admin. You can re-enable this
channel at any time.
"""
uninstallMessage: String!
"""Webpage where you can uninstall the app."""
uninstallUrl: URL @deprecated(reason: "Use AppInstallation.uninstallUrl instead")
}
type AppConnection {
"""A list of edges."""
edges: [AppEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""
App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify.
"""
type AppCredit implements Node {
"""The amount that can be used towards future app purchases in Shopify."""
amount: MoneyV2!
"""The date and time when the app credit was created."""
createdAt: DateTime!
"""The description of the app credit."""
description: String!
"""Globally unique identifier."""
id: ID!
"""Whether the app credit is a test transaction."""
test: Boolean!
}
type AppCreditConnection {
"""A list of edges."""
edges: [AppCreditEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""Return type for `appCreditCreate` mutation."""
type AppCreditCreatePayload {
"""The newly created app credit."""
appCredit: AppCredit
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
type AppCreditEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppCreditEdge."""
node: AppCredit!
}
type AppEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppEdge."""
node: App!
}
"""
Reports the status of shops and their resources and displays this information
within Shopify admin. AppFeedback is used to notify merchants about steps they need to take
to set up an app on their store.
"""
type AppFeedback {
"""The application associated to the feedback."""
app: App!
"""A link to where merchants can resolve errors."""
link: Link
"""The feedback message presented to the merchant."""
messages: [UserError!]!
}
"""Represents an installed application on a shop."""
type AppInstallation implements Node {
"""Access scopes granted to an app by a merchant during installation."""
accessScopes: [AccessScope!]!
"""Active subscriptions charged to a shop on a recurring basis."""
activeSubscriptions: [AppSubscription!]!
"""All subscriptions created for a shop."""
allSubscriptions(
"""Returns up to the first `n` elements from the list."""
first: Int
"""Returns the elements that come after the specified cursor."""
after: String
"""Returns up to the last `n` elements from the list."""
last: Int
"""Returns the elements that come before the specified cursor."""
before: String
"""Reverse the order of the underlying list."""
reverse: Boolean = false
"""Sort the underlying list by the given key."""
sortKey: AppSubscriptionSortKeys = CREATED_AT
): AppSubscriptionConnection!
"""Application which is installed."""
app: App!
"""Channel associated with the installed application."""
channel: Channel @deprecated(reason: "Use `publication` instead")
"""Credits that can be used towards future app purchases."""
credits(
"""Returns up to the first `n` elements from the list."""
first: Int
"""Returns the elements that come after the specified cursor."""
after: String
"""Returns up to the last `n` elements from the list."""
last: Int
"""Returns the elements that come before the specified cursor."""
before: String
"""Reverse the order of the underlying list."""
reverse: Boolean = false
"""Sort the underlying list by the given key."""
sortKey: AppTransactionSortKeys = CREATED_AT
): AppCreditConnection!
"""Globally unique identifier."""
id: ID!
"""Url used to launch the app."""
launchUrl: URL!
"""One-time purchases to a shop."""
oneTimePurchases(
"""Returns up to the first `n` elements from the list."""
first: Int
"""Returns the elements that come after the specified cursor."""
after: String
"""Returns up to the last `n` elements from the list."""
last: Int
"""Returns the elements that come before the specified cursor."""
before: String
"""Reverse the order of the underlying list."""
reverse: Boolean = false
"""Sort the underlying list by the given key."""
sortKey: AppTransactionSortKeys = CREATED_AT
): AppPurchaseOneTimeConnection!
"""Publication associated with the installed application."""
publication: Publication
"""Subscriptions charge to a shop on a recurring basis."""
subscriptions: [AppSubscription!]! @deprecated(reason: "Use `activeSubscriptions` instead")
"""Webpage where you can uninstall the app."""
uninstallUrl: URL
}
"""Possible categories of an app installation."""
enum AppInstallationCategory {
"""Sales channel apps."""
CHANNEL
"""Apps that can be used in the POS mobile client."""
POS_EMBEDDED
}
type AppInstallationConnection {
"""A list of edges."""
edges: [AppInstallationEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
type AppInstallationEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppInstallationEdge."""
node: AppInstallation!
}
"""Possible privacy types of an app installation."""
enum AppInstallationPrivacy {
PUBLIC
PRIVATE
}
"""The set of valid sort keys for the AppInstallation query."""
enum AppInstallationSortKeys {
"""Sort by the `installed_at` value."""
INSTALLED_AT
"""Sort by the `app_title` value."""
APP_TITLE
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""Defines the pricing model for the app subscription."""
input AppPlanInput {
"""Usage based billing pricing details."""
appUsagePricingDetails: AppUsagePricingInput
"""Recurring based billing pricing details."""
appRecurringPricingDetails: AppRecurringPricingInput
}
"""Defines the app plan the merchant is subscribed to."""
type AppPlanV2 {
"""Defines the pricing model for the app subscription."""
pricingDetails: AppPricingDetails!
}
"""Information about the price charged to a shop every plan period."""
union AppPricingDetails = AppUsagePricing | AppRecurringPricing
"""Interval for which pricing details are applied."""
enum AppPricingInterval {
"""App plan pricing details are applied every 30 days."""
EVERY_30_DAYS
}
"""Services and features purchased once by the store."""
interface AppPurchase {
"""The date and time when the app purchase was created."""
createdAt: DateTime!
"""The name of the app purchase."""
name: String!
"""The amount to be charged to the store for the app purchase."""
price: MoneyV2!
"""
The status of the app purchase. Possible values include pending, active, declined and cancelled.
"""
status: AppPurchaseStatus!
"""Whether the app purchase is a test transaction."""
test: Boolean!
}
"""Services and features purchased once by a store."""
type AppPurchaseOneTime implements AppPurchase & Node {
"""The date and time when the app purchase was created."""
createdAt: DateTime!
"""Globally unique identifier."""
id: ID!
"""The name of the app purchase."""
name: String!
"""The amount to be charged to the store for the app purchase."""
price: MoneyV2!
"""
The status of the app purchase. Possible values include pending, active, declined and cancelled.
"""
status: AppPurchaseStatus!
"""Whether the app purchase is a test transaction."""
test: Boolean!
}
type AppPurchaseOneTimeConnection {
"""A list of edges."""
edges: [AppPurchaseOneTimeEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""Return type for `appPurchaseOneTimeCreate` mutation."""
type AppPurchaseOneTimeCreatePayload {
"""The newly created app one-time purchase."""
appPurchaseOneTime: AppPurchaseOneTime
"""
The URL where the merchant can approve or decline the app one-time purchase.
"""
confirmationUrl: URL
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
type AppPurchaseOneTimeEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppPurchaseOneTimeEdge."""
node: AppPurchaseOneTime!
}
"""The status of the purchase."""
enum AppPurchaseStatus {
"""
The app purchase has been approved by the merchant and is ready to be
activated by the app. App purchases created through the GraphQL Admin API are
activated upon approval.
"""
ACCEPTED
"""
The app purchase has been activated by the app. Active app purchases are
charged to the store and partners receive payouts for active app purchase.
"""
ACTIVE
"""The app purchase was declined by the merchant."""
DECLINED
"""The app purchase was not accepted within 2 days of being created."""
EXPIRED
"""The app purchase is pending approval by the merchant."""
PENDING
}
"""Price charged every interval."""
type AppRecurringPricing {
"""
Specifies the number of days in a billing cycle of the app subscription.
"""
interval: AppPricingInterval!
"""The amount to be charged to the store every billing interval."""
price: MoneyV2!
}
"""Allows an app to charge per billing interval."""
input AppRecurringPricingInput {
"""
The amount to be charged to the store every billing interval. The only permitted currency code is USD.
"""
price: MoneyInput!
}
"""The set of valid sort keys for the Apps query."""
enum AppsSortKeys {
"""Sort by the `title` value."""
TITLE
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""
Provides users access to services and/or features for a duration of time.
"""
type AppSubscription implements Node {
"""The date and time when the app subscription was created."""
createdAt: DateTime!
"""The date and time when the current app subscription period ends."""
currentPeriodEnd: DateTime
"""Globally unique identifier."""
id: ID!
"""Attaches a plan to an app subscription."""
lineItems: [AppSubscriptionLineItem!]!
"""The name of the app subscription."""
name: String!
"""
The URL where the merchant is redirected after approving the app subscription.
"""
returnUrl: URL!
"""
The status of the app subscription. Possible values include pending, active, declined,
expired, frozen, and cancelled.
"""
status: AppSubscriptionStatus!
"""Specifies whether the app subscription is a test transaction."""
test: Boolean!
"""The number of days of the free trial."""
trialDays: Int!
}
"""Return type for `appSubscriptionCancel` mutation."""
type AppSubscriptionCancelPayload {
"""The cancelled app subscription."""
appSubscription: AppSubscription
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
type AppSubscriptionConnection {
"""A list of edges."""
edges: [AppSubscriptionEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""Return type for `appSubscriptionCreate` mutation."""
type AppSubscriptionCreatePayload {
"""The newly created app subscription."""
appSubscription: AppSubscription
"""The URL where the merchant approves or declines an app subscription."""
confirmationUrl: URL
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
type AppSubscriptionEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppSubscriptionEdge."""
node: AppSubscription!
}
"""Attaches a plan to an app subscription."""
type AppSubscriptionLineItem {
"""Globally unique identifier."""
id: ID!
"""Defines the pricing model for the app subscription."""
plan: AppPlanV2!
"""Lists the store's usage for a usage pricing plan."""
usageRecords(
"""Returns up to the first `n` elements from the list."""
first: Int
"""Returns the elements that come after the specified cursor."""
after: String
"""Returns up to the last `n` elements from the list."""
last: Int
"""Returns the elements that come before the specified cursor."""
before: String
"""Reverse the order of the underlying list."""
reverse: Boolean = false
"""Sort the underlying list by the given key."""
sortKey: AppUsageRecordSortKeys = CREATED_AT
): AppUsageRecordConnection!
}
"""Allows an app to add more than one plan to an app subscription."""
input AppSubscriptionLineItemInput {
"""Defines the pricing model for the app subscription."""
plan: AppPlanInput!
}
"""Return type for `appSubscriptionLineItemUpdate` mutation."""
type AppSubscriptionLineItemUpdatePayload {
"""The updated app subscription."""
appSubscription: AppSubscription
"""
The URL where the merchant approves or declines the updated app subscription line item.
"""
confirmationUrl: URL
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
"""The set of valid sort keys for the AppSubscription query."""
enum AppSubscriptionSortKeys {
"""Sort by the `created_at` value."""
CREATED_AT
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""The status of the app subscription."""
enum AppSubscriptionStatus {
"""The app subscription is pending approval by the merchant."""
PENDING
"""
The app subscription has been approved by the merchant and is ready to be
activated by the app. App subscriptions created through the GraphQL Admin API
are activated upon approval.
"""
ACCEPTED
"""
The app subscription has been activated by the app. Active app subscriptions
are charged to the store and partners recieve payouts for active app subscriptions.
"""
ACTIVE
"""The app subscription was declined by the merchant."""
DECLINED
"""The app subscription was not accepted within 2 days of being created."""
EXPIRED
"""
The app subscription is on hold due to a store subscription non-payment. The
charge will re-activate once subscription payments resume.
"""
FROZEN
"""The app subscription was cancelled by the app."""
CANCELLED
}
"""The set of valid sort keys for the AppTransaction query."""
enum AppTransactionSortKeys {
"""Sort by the `created_at` value."""
CREATED_AT
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""Defines the usage pricing model for the app subscription."""
type AppUsagePricing {
"""The total usage records for interval."""
balanceUsed: MoneyV2!
"""The limit a store can be charged for usage based pricing."""
cappedAmount: MoneyV2!
"""Specifies the interval which usage records are applied."""
interval: AppPricingInterval!
"""The terms and conditions for app usage pricing."""
terms: String!
}
"""Allows an app to charge a store for usage."""
input AppUsagePricingInput {
"""The limit a customer can be charged for usage based pricing."""
cappedAmount: MoneyInput!
"""The terms and conditions for app usage."""
terms: String!
}
"""Store usage for app subscriptions with usage pricing."""
type AppUsageRecord implements Node {
"""The date and time when the usage record was created."""
createdAt: DateTime!
"""The description of the app usage record."""
description: String!
"""Globally unique identifier."""
id: ID!
"""
The price of the usage record. The only permitted currency code is USD.
"""
price: MoneyV2!
"""Defines the usage pricing plan the merchant is subscribed to."""
subscriptionLineItem: AppSubscriptionLineItem!
}
type AppUsageRecordConnection {
"""A list of edges."""
edges: [AppUsageRecordEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""Return type for `appUsageRecordCreate` mutation."""
type AppUsageRecordCreatePayload {
"""The newly created app usage record."""
appUsageRecord: AppUsageRecord
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
type AppUsageRecordEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of AppUsageRecordEdge."""
node: AppUsageRecord!
}
"""The set of valid sort keys for the AppUsageRecord query."""
enum AppUsageRecordSortKeys {
"""Sort by the `created_at` value."""
CREATED_AT
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""Represents a generic custom attribute."""
type Attribute {
"""Key or name of the attribute."""
key: String!
"""Value of the attribute."""
value: String
}
"""Specifies the input fields required for an attribute."""
input AttributeInput {
"""Key or name of the attribute."""
key: String!
"""Value of the attribute."""
value: String!
}
"""
Automatic discount applications capture the intentions of a discount that was automatically applied.
"""
type AutomaticDiscountApplication implements DiscountApplication {
"""
The method by which the discount's value is allocated to its entitled items.
"""
allocationMethod: DiscountApplicationAllocationMethod!
"""
An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations.
"""
index: Int!
"""How the discount amount is distributed on the discounted lines."""
targetSelection: DiscountApplicationTargetSelection!
"""Whether the discount is applied on line items or shipping lines."""
targetType: DiscountApplicationTargetType!
"""The title of the discount application."""
title: String!
"""The value of the discount application."""
value: PricingValue!
}
"""The set of valid sort keys for the AutomaticDiscount query."""
enum AutomaticDiscountSortKeys {
"""Sort by the `created_at` value."""
CREATED_AT
"""Sort by the `id` value."""
ID
"""
During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
results by relevance to the search term(s). When no search query is specified, this sort key is not
deterministic and should not be used.
"""
RELEVANCE
}
"""
Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or
the addition of a product.
"""
type BasicEvent implements Node & Event {
"""
The name of the app that created the event. Returns null when the event originates from the Shopify admin.
"""
appTitle: String
"""Whether the event was created by an app."""
attributeToApp: Boolean!
"""Whether the event was caused by an admin user."""
attributeToUser: Boolean!
"""The date and time when the event was created."""
createdAt: DateTime!
"""Whether the event is critical."""
criticalAlert: Boolean!
"""Globally unique identifier."""
id: ID!
"""Human readable text that describes the event."""
message: FormattedString!
}
"""
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the `bulkOperationRunQuery` mutation. After they are created,
clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains
a link to the data in [JSONL](http://jsonlines.org/) format.
See the [bulk operations guide](https://help.shopify.com/api/guides/bulk-operations) for more details.
"""
type BulkOperation implements Node {
"""When the bulk operation was successfully completed."""
completedAt: DateTime
"""When the bulk operation was created."""
createdAt: DateTime!
"""Error code for failed operations."""
errorCode: BulkOperationErrorCode
"""File size in bytes of the file in the `url` field."""
fileSize: UnsignedInt64
"""Globally unique identifier."""
id: ID!
"""
The running count of all objects processed.
For example, when fetching all products and their variants, this field counts both products and variants.
This field can be used to track operation progress.
"""
objectCount: UnsignedInt64!
"""
URL to partial/incomplete response data (in [JSONL](http://jsonlines.org/) format) returned by a failed operation.
Expires **one week** after the operation fails. Returns `null` when there's no data available.
"""
partialDataUrl: URL
"""GraphQL query document specified in `bulkOperationRunQuery`."""
query: String!
"""Status of the bulk operation."""
status: BulkOperationStatus!
"""
URL to the response data in [JSONL](http://jsonlines.org/) format.
Expires **one week** after the operation completes.
"""
url: URL
}
"""Return type for `bulkOperationCancel` mutation."""
type BulkOperationCancelPayload {
"""The bulk operation to be canceled."""
bulkOperation: BulkOperation
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
"""Error codes for failed bulk operations."""
enum BulkOperationErrorCode {
"""
The provided operation `query` returned access denied due to missing
[access scopes](https://help.shopify.com/api/getting-started/authentication/oauth/scopes).
Review the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details.
"""
ACCESS_DENIED
"""
Operation resulted in partial or incomplete data due to internal server errors during execution.
"""
INTERNAL_SERVER_ERROR
"""
Operation resulted in partial or incomplete data due to query timeouts during execution.
In some cases, timeouts can be avoided by modifying your `query` to select fewer fields.
"""
TIMEOUT
}
"""Return type for `bulkOperationRunQuery` mutation."""
type BulkOperationRunQueryPayload {
"""The newly created bulk operation."""
bulkOperation: BulkOperation
"""List of errors that occurred executing the mutation."""
userErrors: [UserError!]!
}
"""Statuses of a bulk operation."""
enum BulkOperationStatus {
"""Operation created."""
CREATED
"""Operation running."""
RUNNING
"""Operation completed."""
COMPLETED
"""Operation canceling."""
CANCELING
"""Operation canceled."""
CANCELED
"""Operation failed."""
FAILED
"""Operation URL has expired."""
EXPIRED
}
"""The computed properties for a draft order."""
type CalculatedDraftOrder {
"""Order-level discount applied to the draft order."""
appliedDiscount: DraftOrderAppliedDiscount
"""
The available shipping rates for the draft order. Requires a customer with a
valid shipping address and at least one line item.
"""
availableShippingRates: [ShippingRate!]!