-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathshopify.graphql
27071 lines (24573 loc) · 901 KB
/
shopify.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: QueryRoot
mutation: Mutation
}
"Marks an element of a GraphQL schema as having restricted access."
directive @accessRestricted(
"Explains the reason around this restriction"
reason: String
) on OBJECT | FIELD_DEFINITION
"Services and features purchased once by the store."
interface AppPurchase {
"The date and time when the app purchase occurred."
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."
status: AppPurchaseStatus!
"Whether the app purchase is a test transaction."
test: Boolean!
}
"""
A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied.
"""
interface CalculatedDiscountApplication {
"The method by which the discount's value is allocated to its entitled items."
allocationMethod: DiscountApplicationAllocationMethod!
"The level at which the discount was applied."
appliedTo: DiscountApplicationLevel!
"The description of discount application. Indicates the reason why the discount was applied."
description: String
"A globally-unique identifier."
id: ID!
"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 value of the discount application."
value: PricingValue!
}
"The subject line of a comment event."
interface CommentEventSubject {
"Whether the timeline subject has a timeline comment. If true, then a timeline comment exists."
hasTimelineComment: Boolean!
"A globally-unique identifier."
id: ID!
}
"Represents a session preceding an order, often used for building a timeline of events leading to an order."
interface CustomerMoment {
"The date and time when the customer's session occurred."
occurredAt: DateTime!
}
"""
Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines.
"""
interface 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 value of the discount application."
value: PricingValue!
}
"Represents an error in the input of a mutation."
interface DisplayableError {
"The path to the input field that caused the error."
field: [String!]
"The error message."
message: String!
}
"""
Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the
addition of a product.
"""
interface Event {
"The name of the app that created the event."
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!
"A globally-unique identifier."
id: ID!
"Human readable text that describes the event."
message: FormattedString!
}
"A file interface."
interface File {
"A word or phrase to describe the contents or the function of a file."
alt: String
"""
The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created.
"""
createdAt: DateTime!
"Any errors that have occurred on the file."
fileErrors: [FileError!]!
"The status of the file."
fileStatus: FileStatus!
"The preview image for the media."
preview: MediaPreviewImage
}
"Represents an object that has a list of events."
interface HasEvents {
"The paginated list of events associated with the host subject."
events(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"""
Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters.
"""
query: String,
"Reverse the order of the underlying list."
reverse: Boolean = false,
"Sort the underlying list by the given key."
sortKey: EventSortKeys = ID
): EventConnection!
}
"""
Localization extensions associated with the specified resource. For example, the tax id for government invoice.
"""
interface HasLocalizationExtensions {
"List of localization extensions for the resource."
localizationExtensions(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"The country codes of the extensions."
countryCodes: [CountryCode!],
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"The purpose of the extensions."
purposes: [LocalizationExtensionPurpose!],
"Reverse the order of the underlying list."
reverse: Boolean = false
): LocalizationExtensionConnection!
}
"Resources that metafield definitions can be applied to."
interface HasMetafieldDefinitions {
"List of metafield definitions."
metafieldDefinitions(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Filter metafield definitions by namespace."
namespace: String,
"Filter by the definition's pinned status."
pinnedStatus: MetafieldDefinitionPinnedStatus = ANY,
"""
Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters.
"""
query: String,
"Reverse the order of the underlying list."
reverse: Boolean = false,
"Sort the underlying list by the given key."
sortKey: MetafieldDefinitionSortKeys = ID
): MetafieldDefinitionConnection!
}
"Represents information about the metafields associated to the specified resource."
interface HasMetafields {
"Returns a metafield by namespace and key that belongs to the resource."
metafield(
"The key for the metafield."
key: String!,
"The namespace for the metafield."
namespace: String!
): Metafield
"List of metafields that belong to the resource."
metafields(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"The metafield namespace to filter by."
namespace: String,
"Reverse the order of the underlying list."
reverse: Boolean = false
): MetafieldConnection!
"Returns a private metafield by namespace and key that belongs to the resource."
privateMetafield(
"The key for the private metafield."
key: String!,
"The namespace for the private metafield."
namespace: String!
): PrivateMetafield
"List of private metafields that belong to the resource."
privateMetafields(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Filter the private metafields by namespace."
namespace: String,
"Reverse the order of the underlying list."
reverse: Boolean = false
): PrivateMetafieldConnection!
}
"Published translations associated with the resource."
interface HasPublishedTranslations {
"The translations associated with the resource."
translations(
"Filters translations locale."
locale: String!
): [PublishedTranslation!]!
}
"""
Interoperability metadata for types that directly correspond to a REST Admin API resource.
For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API.
"""
interface LegacyInteroperability {
"The ID of the corresponding resource in the REST Admin API."
legacyResourceId: UnsignedInt64!
}
"Represents a media interface."
interface Media {
"A word or phrase to share the nature or contents of a media."
alt: String
"The media content type."
mediaContentType: MediaContentType!
"Any errors which have occurred on the media."
mediaErrors: [MediaError!]!
"The warnings attached to the media."
mediaWarnings: [MediaWarning!]!
"The preview image for the media."
preview: MediaPreviewImage
"Current status of the media."
status: MediaStatus!
}
"""
A default cursor that you can use in queries to paginate your results. Each edge in a connection can
return a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as
the starting point to retrieve the nodes before or after it in a connection.
To learn more about using cursor-based pagination, refer to
[Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql).
"""
interface Navigable {
"""
A default cursor that returns the single next record, sorted ascending by ID.
"""
defaultCursor: String!
}
"""
An object with an ID field to support global identification, in accordance with the
[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).
This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)
and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.
"""
interface Node {
"A globally-unique identifier."
id: ID!
}
"Online Store preview URL of the object."
interface OnlineStorePreviewable {
"The online store preview URL."
onlineStorePreviewUrl: URL
}
"""
Represents a resource that can be published to a channel.
A publishable resource can be either a Product or Collection.
"""
interface Publishable {
"The number of publications a resource is published to without feedback errors."
availablePublicationCount: Int!
"The number of publications a resource is published on."
publicationCount(
"Include only the resource's publications that are published. If false, then return all the resource's publications including future publications."
onlyPublished: Boolean = true
): Int!
"Check to see whether the resource is published to a given channel."
publishedOnChannel(
"The ID of the channel to check."
channelId: ID!
): Boolean! @deprecated(reason: "Use `publishedOnPublication` instead")
"Check to see whether the resource is published to the calling app's channel."
publishedOnCurrentChannel: Boolean! @deprecated(reason: "Use `publishedOnCurrentPublication` instead")
"Check to see whether the resource is published to the calling app's publication."
publishedOnCurrentPublication: Boolean!
"Check to see whether the resource is published to a given publication."
publishedOnPublication(
"The ID of the publication to check."
publicationId: ID!
): Boolean!
"The list of resources that are published to a publication."
resourcePublications(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"""
Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
"""
onlyPublished: Boolean = true,
"Reverse the order of the underlying list."
reverse: Boolean = false
): ResourcePublicationConnection!
"The list of resources that are either published or staged to be published to a publication."
resourcePublicationsV2(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"""
Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
"""
onlyPublished: Boolean = true,
"Reverse the order of the underlying list."
reverse: Boolean = false
): ResourcePublicationV2Connection!
"The list of channels that the resource is not published to."
unpublishedChannels(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false
): ChannelConnection! @deprecated(reason: "Use `unpublishedPublications` instead")
"The list of publications that the resource is not published to."
unpublishedPublications(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false
): PublicationConnection!
}
"An individual sale record associated with a sales agreement."
interface Sale {
"The type of order action that the sale represents."
actionType: SaleActionType!
"The unique identifier for the sale."
id: ID!
"The line type assocated with the sale."
lineType: SaleLineType!
"The number of units either ordered or intended to be returned."
quantity: Int
"All individual taxes associated with the sale."
taxes: [SaleTax!]!
"The total sale amount after taxes and discounts."
totalAmount: MoneyBag!
"The total discounts allocated to the sale after taxes."
totalDiscountAmountAfterTaxes: MoneyBag!
"The total discounts allocated to the sale before taxes."
totalDiscountAmountBeforeTaxes: MoneyBag!
"The total amount of taxes for the sale."
totalTaxAmount: MoneyBag!
}
"An addition, removal, modification, or other sale commitment associated with an order."
interface SalesAgreement {
"The application that created the agreement."
app: App
"The date and time at which the agreement occured."
happenedAt: DateTime!
"The unique identifier for the agreement."
id: ID!
"The reason the agremeent was created."
reason: OrderActionType!
"The sales associated with the agreement."
sales(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false
): SaleConnection!
}
"Represents selling plan pricing policy common fields."
interface SellingPlanPricingPolicyBase {
"The price adjustment type."
adjustmentType: SellingPlanPricingPolicyAdjustmentType!
"The price adjustment value."
adjustmentValue: SellingPlanPricingPolicyAdjustmentValue!
}
"The charge descriptors for a payments account."
interface ShopifyPaymentsChargeStatementDescriptor {
"The default charge statement descriptor."
default: String
"The prefix of the statement descriptor."
prefix: String!
}
"""
The information about the price that's charged to a shop every plan period.
The concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing.
"""
union AppPricingDetails = AppRecurringPricing | AppUsagePricing
"The main embed of a comment event."
union CommentEventEmbed = Customer | DraftOrder | Order | Product | ProductVariant
"All possible instruments for CustomerPaymentMethods."
union CustomerPaymentInstrument = CustomerCreditCard | CustomerPaypalBillingAgreement | CustomerShopPayAgreement
"The value (weight or price) that the condition field is compared to."
union DeliveryConditionCriteria = MoneyV2 | Weight
"A rate provided by a merchant-defined rate or a participant."
union DeliveryRateProvider = DeliveryParticipant | DeliveryRateDefinition
"An automatic discount."
union DiscountAutomatic = DiscountAutomaticBasic | DiscountAutomaticBxgy
"A code discount."
union DiscountCode = DiscountCodeBasic | DiscountCodeBxgy | DiscountCodeFreeShipping
"The prerequisite quantity required for the discount to be applicable."
union DiscountCustomerBuysValue = DiscountPurchaseAmount | DiscountQuantity
"The value of the discount and how it will be applied."
union DiscountCustomerGetsValue = DiscountAmount | DiscountOnQuantity | DiscountPercentage
"The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers."
union DiscountCustomerSelection = DiscountCustomerAll | DiscountCustomerSavedSearches | DiscountCustomers
"The type of discount that will be applied. Currently, only percentage off is supported."
union DiscountEffect = DiscountPercentage
"""
Entitled or prerequisite items on a discount. An item could be either collection or product or product_variant.
"""
union DiscountItems = AllDiscountItems | DiscountCollections | DiscountProducts
"The minimum subtotal or quantity requirements for the discount."
union DiscountMinimumRequirement = DiscountMinimumQuantity | DiscountMinimumSubtotal
"The selection of shipping countries to which this discount applies."
union DiscountShippingDestinationSelection = DiscountCountries | DiscountCountryAll
"""
The resource referenced by the metafield value.
"""
union MetafieldReference = GenericFile | MediaImage | OnlineStorePage | Product | ProductVariant
"""
A change that has been applied to an order.
"""
union OrderStagedChange = OrderStagedChangeAddCustomItem | OrderStagedChangeAddLineItemDiscount | OrderStagedChangeAddShippingLine | OrderStagedChangeAddVariant | OrderStagedChangeDecrementItem | OrderStagedChangeIncrementItem
"The value of the price rule."
union PriceRuleValue = PriceRuleFixedAmountValue | PriceRulePercentValue
"The value of the pricing object."
union PricingValue = MoneyV2 | PricingPercentageValue
"""
Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every
three months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing
policies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.
We recommend backing up these records if you need to restore them later.
"""
union SellingPlanBillingPolicy = SellingPlanRecurringBillingPolicy
"""
Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver
every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans,
pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.
We recommend backing up these records if you need to restore them later.
"""
union SellingPlanDeliveryPolicy = SellingPlanRecurringDeliveryPolicy
"""
Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set
for a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and
associated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48
hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need
to restore them later.
"""
union SellingPlanPricingPolicy = SellingPlanFixedPricingPolicy | SellingPlanRecurringPricingPolicy
"Represents a selling plan pricing policy adjustment value type."
union SellingPlanPricingPolicyAdjustmentValue = MoneyV2 | SellingPlanPricingPolicyPercentageValue
"Describes the delivery method to use to get the physical goods to the customer."
union SubscriptionDeliveryMethod = SubscriptionDeliveryMethodShipping
"Subscription draft discount types."
union SubscriptionDiscount = SubscriptionAppliedCodeDiscount | SubscriptionManualDiscount
"The value of the discount and how it will be applied."
union SubscriptionDiscountValue = SubscriptionDiscountFixedAmountValue | SubscriptionDiscountPercentageValue
"The result of the query to fetch shipping options for the subscription contract."
union SubscriptionShippingOptionResult = SubscriptionShippingOptionResultFailure | SubscriptionShippingOptionResultSuccess
"Information about the payment instrument used for this transaction."
union TenderTransactionDetails = TenderTransactionCreditCardDetails
"An endpoint to which webhook subscriptions send webhooks events."
union WebhookSubscriptionEndpoint = WebhookEventBridgeEndpoint | WebhookHttpEndpoint | WebhookPubSubEndpoint
"""
Represents the permission required to access a Shopify Admin API or Storefront API resource for a shop. Access scopes are granted by merchants to requesting applications.
"""
type AccessScope {
"Description of the resource access provided by the access scope when granted to an application."
description: String!
"""
Represents the access scope as a readable string. Typically follows the format `{action}_{resource}`: a `read` or `write` action, followed by the resource on which the action is allowed to be performed on, separated by an underscore. For example, `read_orders`; `write_products`.
"""
handle: String!
}
"A sale associated with an order price adjustment."
type AdjustmentSale implements Sale {
"The type of order action that the sale represents."
actionType: SaleActionType!
"The unique identifier for the sale."
id: ID!
"The line type assocated with the sale."
lineType: SaleLineType!
"The number of units either ordered or intended to be returned."
quantity: Int
"All individual taxes associated with the sale."
taxes: [SaleTax!]!
"The total sale amount after taxes and discounts."
totalAmount: MoneyBag!
"The total discounts allocated to the sale after taxes."
totalDiscountAmountAfterTaxes: MoneyBag!
"The total discounts allocated to the sale before taxes."
totalDiscountAmountBeforeTaxes: MoneyBag!
"The total amount of taxes for the sale."
totalTaxAmount: MoneyBag!
}
"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, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).
Versions are commonly referred to by their handle (for example, `2021-10`).
"""
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 actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning)."
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
"The name of the app developer."
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!]!
"A list of app features that are shown in the Shopify App Store listing."
features: [String!]!
"Feedback from this app about the store."
feedback: AppFeedback
"Handle of the app."
handle: String
"Icon that represents the app."
icon: Image!
"A 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
"""
Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.
"""
isPostPurchaseAppInUse: Boolean!
"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 to the Shopify App Store."
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")
}
"""
An auto-generated type for paginating through multiple Apps.
"""
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!
"A globally-unique identifier."
id: ID!
"Whether the app credit is a test transaction."
test: Boolean!
}
"""
An auto-generated type for paginating through multiple AppCredits.
"""
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
"The list of errors that occurred from executing the mutation."
userErrors: [UserError!]!
}
"""
An auto-generated type which holds one AppCredit and a cursor during pagination.
"""
type AppCreditEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of AppCreditEdge."
node: AppCredit!
}
"""
An auto-generated type which holds one App and a cursor during pagination.
"""
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 {
"The access scopes granted to the application by a merchant during installation."
accessScopes: [AccessScope!]!
"The active application subscriptions billed to the shop on a recurring basis."
activeSubscriptions: [AppSubscription!]!
"All subscriptions created for a shop."
allSubscriptions(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"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 the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false,
"Sort the underlying list by the given key."
sortKey: AppTransactionSortKeys = CREATED_AT
): AppCreditConnection!
"A globally-unique identifier."
id: ID!
"The URL to launch the application."
launchUrl: URL!
"One-time purchases to a shop."
oneTimePurchases(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false,
"Sort the underlying list by the given key."
sortKey: AppTransactionSortKeys = CREATED_AT
): AppPurchaseOneTimeConnection!
"The publication associated with the installed application."
publication: Publication
"The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes."
revenueAttributionRecords(
"Returns the elements that come after the specified cursor."
after: String,
"Returns the elements that come before the specified cursor."
before: String,
"Returns up to the first `n` elements from the list."
first: Int,
"Returns up to the last `n` elements from the list."
last: Int,
"Reverse the order of the underlying list."
reverse: Boolean = false,
"Sort the underlying list by the given key."
sortKey: AppRevenueAttributionRecordSortKeys = CREATED_AT
): AppRevenueAttributionRecordConnection!
"Subscriptions charge to a shop on a recurring basis."
subscriptions: [AppSubscription!]! @deprecated(reason: "Use `activeSubscriptions` instead")
"The URL to uninstall the application."
uninstallUrl: URL
}
"""
An auto-generated type for paginating through multiple AppInstallations.
"""
type AppInstallationConnection {
"A list of edges."
edges: [AppInstallationEdge!]!
"Information to aid in pagination."
pageInfo: PageInfo!
}
"""
An auto-generated type which holds one AppInstallation and a cursor during pagination.
"""
type AppInstallationEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of AppInstallationEdge."
node: AppInstallation!
}
"The app plan that the merchant is subscribed to."
type AppPlanV2 {
"The plan billed to a shop on a recurring basis."
pricingDetails: AppPricingDetails!
}
"Services and features purchased once by a store."
type AppPurchaseOneTime implements AppPurchase & Node {
"The date and time when the app purchase occurred."
createdAt: DateTime!
"A 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."
status: AppPurchaseStatus!
"Whether the app purchase is a test transaction."
test: Boolean!
}
"""
An auto-generated type for paginating through multiple AppPurchaseOneTimes.
"""
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 that the merchant can access to approve or decline the newly created app one-time purchase.
If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined.
If the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`.
You get paid after the charge is activated.
"""
confirmationUrl: URL
"The list of errors that occurred from executing the mutation."
userErrors: [UserError!]!
}
"""
An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination.
"""
type AppPurchaseOneTimeEdge {
"A cursor for use in pagination."
cursor: String!
"The item at the end of AppPurchaseOneTimeEdge."
node: AppPurchaseOneTime!
}
"""
The pricing information about a subscription app.
The object contains an interval (the frequency at which the shop is billed for an app subscription) and
a price (the amount to be charged to the subscribing shop at each interval).
"""
type AppRecurringPricing {
"The frequency at which the subscribing shop is billed for an app subscription."
interval: AppPricingInterval!
"The amount and currency to be charged to the subscribing shop every billing interval."
price: MoneyV2!
}