-
Notifications
You must be signed in to change notification settings - Fork 241
/
storefront-api-types.d.ts
8356 lines (7856 loc) · 290 KB
/
storefront-api-types.d.ts
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 IS AUTO-GENERATED, DO NOT EDIT
* Based on Storefront API 2024-04
* If changes need to happen to the types defined in this file, then generally the Storefront API needs to update. After it's updated, you can run `npm run graphql-types`.
* Except custom Scalars, which are defined in the `codegen.ts` file
*/
/* eslint-disable */
export type Maybe<T> = T | null;
export type InputMaybe<T> = Maybe<T>;
export type Exact<T extends {[key: string]: unknown}> = {[K in keyof T]: T[K]};
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]?: Maybe<T[SubKey]>;
};
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]: Maybe<T[SubKey]>;
};
export type MakeEmpty<T extends {[key: string]: unknown}, K extends keyof T> = {
[_ in K]?: never;
};
export type Incremental<T> =
| T
| {[P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never};
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: {input: string; output: string};
String: {input: string; output: string};
Boolean: {input: boolean; output: boolean};
Int: {input: number; output: number};
Float: {input: number; output: number};
Color: {input: string; output: string};
DateTime: {input: string; output: string};
Decimal: {input: string; output: string};
HTML: {input: string; output: string};
JSON: {input: unknown; output: unknown};
URL: {input: string; output: string};
UnsignedInt64: {input: string; output: string};
};
/**
* 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`).
*
*/
export type ApiVersion = {
__typename?: 'ApiVersion';
/** The human-readable name of the version. */
displayName: Scalars['String']['output'];
/** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */
handle: Scalars['String']['output'];
/** 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: Scalars['Boolean']['output'];
};
/**
* The input fields for submitting Apple Pay payment method information for checkout.
*
*/
export type ApplePayWalletContentInput = {
/** The customer's billing address. */
billingAddress: MailingAddressInput;
/** The data for the Apple Pay wallet. */
data: Scalars['String']['input'];
/** The header data for the Apple Pay wallet. */
header: ApplePayWalletHeaderInput;
/** The last digits of the card used to create the payment. */
lastDigits?: InputMaybe<Scalars['String']['input']>;
/** The signature for the Apple Pay wallet. */
signature: Scalars['String']['input'];
/** The version for the Apple Pay wallet. */
version: Scalars['String']['input'];
};
/**
* The input fields for submitting wallet payment method information for checkout.
*
*/
export type ApplePayWalletHeaderInput = {
/** The application data for the Apple Pay wallet. */
applicationData?: InputMaybe<Scalars['String']['input']>;
/** The ephemeral public key for the Apple Pay wallet. */
ephemeralPublicKey: Scalars['String']['input'];
/** The public key hash for the Apple Pay wallet. */
publicKeyHash: Scalars['String']['input'];
/** The transaction ID for the Apple Pay wallet. */
transactionId: Scalars['String']['input'];
};
/** Details about the gift card used on the checkout. */
export type AppliedGiftCard = Node & {
__typename?: 'AppliedGiftCard';
/** The amount that was taken from the gift card by applying it. */
amountUsed: MoneyV2;
/**
* The amount that was taken from the gift card by applying it.
* @deprecated Use `amountUsed` instead.
*/
amountUsedV2: MoneyV2;
/** The amount left on the gift card. */
balance: MoneyV2;
/**
* The amount left on the gift card.
* @deprecated Use `balance` instead.
*/
balanceV2: MoneyV2;
/** A globally-unique ID. */
id: Scalars['ID']['output'];
/** The last characters of the gift card. */
lastCharacters: Scalars['String']['output'];
/** The amount that was applied to the checkout in its currency. */
presentmentAmountUsed: MoneyV2;
};
/** An article in an online store blog. */
export type Article = HasMetafields &
Node &
OnlineStorePublishable &
Trackable & {
__typename?: 'Article';
/**
* The article's author.
* @deprecated Use `authorV2` instead.
*/
author: ArticleAuthor;
/** The article's author. */
authorV2?: Maybe<ArticleAuthor>;
/** The blog that the article belongs to. */
blog: Blog;
/** List of comments posted on the article. */
comments: CommentConnection;
/** Stripped content of the article, single line with HTML tags removed. */
content: Scalars['String']['output'];
/** The content of the article, complete with HTML formatting. */
contentHtml: Scalars['HTML']['output'];
/** Stripped excerpt of the article, single line with HTML tags removed. */
excerpt?: Maybe<Scalars['String']['output']>;
/** The excerpt of the article, complete with HTML formatting. */
excerptHtml?: Maybe<Scalars['HTML']['output']>;
/** A human-friendly unique string for the Article automatically generated from its title. */
handle: Scalars['String']['output'];
/** A globally-unique ID. */
id: Scalars['ID']['output'];
/** The image associated with the article. */
image?: Maybe<Image>;
/** Returns a metafield found by namespace and key. */
metafield?: Maybe<Metafield>;
/** The metafields associated with the resource matching the supplied list of namespaces and keys. */
metafields: Array<Maybe<Metafield>>;
/** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */
onlineStoreUrl?: Maybe<Scalars['URL']['output']>;
/** The date and time when the article was published. */
publishedAt: Scalars['DateTime']['output'];
/** The article’s SEO information. */
seo?: Maybe<Seo>;
/**
* A categorization that a article can be tagged with.
*
*/
tags: Array<Scalars['String']['output']>;
/** The article’s name. */
title: Scalars['String']['output'];
/** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */
trackingParameters?: Maybe<Scalars['String']['output']>;
};
/** An article in an online store blog. */
export type ArticleCommentsArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
reverse?: InputMaybe<Scalars['Boolean']['input']>;
};
/** An article in an online store blog. */
export type ArticleContentArgs = {
truncateAt?: InputMaybe<Scalars['Int']['input']>;
};
/** An article in an online store blog. */
export type ArticleExcerptArgs = {
truncateAt?: InputMaybe<Scalars['Int']['input']>;
};
/** An article in an online store blog. */
export type ArticleMetafieldArgs = {
key: Scalars['String']['input'];
namespace?: InputMaybe<Scalars['String']['input']>;
};
/** An article in an online store blog. */
export type ArticleMetafieldsArgs = {
identifiers: Array<HasMetafieldsIdentifier>;
};
/** The author of an article. */
export type ArticleAuthor = {
__typename?: 'ArticleAuthor';
/** The author's bio. */
bio?: Maybe<Scalars['String']['output']>;
/** The author’s email. */
email: Scalars['String']['output'];
/** The author's first name. */
firstName: Scalars['String']['output'];
/** The author's last name. */
lastName: Scalars['String']['output'];
/** The author's full name. */
name: Scalars['String']['output'];
};
/**
* An auto-generated type for paginating through multiple Articles.
*
*/
export type ArticleConnection = {
__typename?: 'ArticleConnection';
/** A list of edges. */
edges: Array<ArticleEdge>;
/** A list of the nodes contained in ArticleEdge. */
nodes: Array<Article>;
/** Information to aid in pagination. */
pageInfo: PageInfo;
};
/**
* An auto-generated type which holds one Article and a cursor during pagination.
*
*/
export type ArticleEdge = {
__typename?: 'ArticleEdge';
/** A cursor for use in pagination. */
cursor: Scalars['String']['output'];
/** The item at the end of ArticleEdge. */
node: Article;
};
/** The set of valid sort keys for the Article query. */
export type ArticleSortKeys =
/** Sort by the `author` value. */
| 'AUTHOR'
/** Sort by the `blog_title` value. */
| 'BLOG_TITLE'
/** Sort by the `id` value. */
| 'ID'
/** Sort by the `published_at` value. */
| 'PUBLISHED_AT'
/**
* Sort by relevance to the search terms when the `query` parameter is specified on the connection.
* Don't use this sort key when no search query is specified.
*
*/
| 'RELEVANCE'
/** Sort by the `title` value. */
| 'TITLE'
/** Sort by the `updated_at` value. */
| 'UPDATED_AT';
/** Represents a generic custom attribute. */
export type Attribute = {
__typename?: 'Attribute';
/** Key or name of the attribute. */
key: Scalars['String']['output'];
/** Value of the attribute. */
value?: Maybe<Scalars['String']['output']>;
};
/** The input fields for an attribute. */
export type AttributeInput = {
/** Key or name of the attribute. */
key: Scalars['String']['input'];
/** Value of the attribute. */
value: Scalars['String']['input'];
};
/**
* Automatic discount applications capture the intentions of a discount that was automatically applied.
*
*/
export type AutomaticDiscountApplication = DiscountApplication & {
__typename?: 'AutomaticDiscountApplication';
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod: DiscountApplicationAllocationMethod;
/** Which lines of targetType that the discount is allocated over. */
targetSelection: DiscountApplicationTargetSelection;
/** The type of line that the discount is applicable towards. */
targetType: DiscountApplicationTargetType;
/** The title of the application. */
title: Scalars['String']['output'];
/** The value of the discount application. */
value: PricingValue;
};
/** A collection of available shipping rates for a checkout. */
export type AvailableShippingRates = {
__typename?: 'AvailableShippingRates';
/**
* Whether or not the shipping rates are ready.
* The `shippingRates` field is `null` when this value is `false`.
* This field should be polled until its value becomes `true`.
*
*/
ready: Scalars['Boolean']['output'];
/** The fetched shipping rates. `null` until the `ready` field is `true`. */
shippingRates?: Maybe<Array<ShippingRate>>;
};
/** Represents a cart line common fields. */
export type BaseCartLine = {
/** An attribute associated with the cart line. */
attribute?: Maybe<Attribute>;
/** The attributes associated with the cart line. Attributes are represented as key-value pairs. */
attributes: Array<Attribute>;
/** The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. */
cost: CartLineCost;
/** The discounts that have been applied to the cart line. */
discountAllocations: Array<
| CartAutomaticDiscountAllocation
| CartCodeDiscountAllocation
| CartCustomDiscountAllocation
>;
/**
* The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout.
* @deprecated Use `cost` instead.
*/
estimatedCost: CartLineEstimatedCost;
/** A globally-unique ID. */
id: Scalars['ID']['output'];
/** The merchandise that the buyer intends to purchase. */
merchandise: Merchandise;
/** The quantity of the merchandise that the customer intends to purchase. */
quantity: Scalars['Int']['output'];
/** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */
sellingPlanAllocation?: Maybe<SellingPlanAllocation>;
};
/** Represents a cart line common fields. */
export type BaseCartLineAttributeArgs = {
key: Scalars['String']['input'];
};
/**
* An auto-generated type for paginating through multiple BaseCartLines.
*
*/
export type BaseCartLineConnection = {
__typename?: 'BaseCartLineConnection';
/** A list of edges. */
edges: Array<BaseCartLineEdge>;
/** A list of the nodes contained in BaseCartLineEdge. */
nodes: Array<CartLine | ComponentizableCartLine>;
/** Information to aid in pagination. */
pageInfo: PageInfo;
};
/**
* An auto-generated type which holds one BaseCartLine and a cursor during pagination.
*
*/
export type BaseCartLineEdge = {
__typename?: 'BaseCartLineEdge';
/** A cursor for use in pagination. */
cursor: Scalars['String']['output'];
/** The item at the end of BaseCartLineEdge. */
node: CartLine | ComponentizableCartLine;
};
/** An online store blog. */
export type Blog = HasMetafields &
Node &
OnlineStorePublishable & {
__typename?: 'Blog';
/** Find an article by its handle. */
articleByHandle?: Maybe<Article>;
/** List of the blog's articles. */
articles: ArticleConnection;
/** The authors who have contributed to the blog. */
authors: Array<ArticleAuthor>;
/**
* A human-friendly unique string for the Blog automatically generated from its title.
*
*/
handle: Scalars['String']['output'];
/** A globally-unique ID. */
id: Scalars['ID']['output'];
/** Returns a metafield found by namespace and key. */
metafield?: Maybe<Metafield>;
/** The metafields associated with the resource matching the supplied list of namespaces and keys. */
metafields: Array<Maybe<Metafield>>;
/** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */
onlineStoreUrl?: Maybe<Scalars['URL']['output']>;
/** The blog's SEO information. */
seo?: Maybe<Seo>;
/** The blogs’s title. */
title: Scalars['String']['output'];
};
/** An online store blog. */
export type BlogArticleByHandleArgs = {
handle: Scalars['String']['input'];
};
/** An online store blog. */
export type BlogArticlesArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
query?: InputMaybe<Scalars['String']['input']>;
reverse?: InputMaybe<Scalars['Boolean']['input']>;
sortKey?: InputMaybe<ArticleSortKeys>;
};
/** An online store blog. */
export type BlogMetafieldArgs = {
key: Scalars['String']['input'];
namespace?: InputMaybe<Scalars['String']['input']>;
};
/** An online store blog. */
export type BlogMetafieldsArgs = {
identifiers: Array<HasMetafieldsIdentifier>;
};
/**
* An auto-generated type for paginating through multiple Blogs.
*
*/
export type BlogConnection = {
__typename?: 'BlogConnection';
/** A list of edges. */
edges: Array<BlogEdge>;
/** A list of the nodes contained in BlogEdge. */
nodes: Array<Blog>;
/** Information to aid in pagination. */
pageInfo: PageInfo;
};
/**
* An auto-generated type which holds one Blog and a cursor during pagination.
*
*/
export type BlogEdge = {
__typename?: 'BlogEdge';
/** A cursor for use in pagination. */
cursor: Scalars['String']['output'];
/** The item at the end of BlogEdge. */
node: Blog;
};
/** The set of valid sort keys for the Blog query. */
export type BlogSortKeys =
/** Sort by the `handle` value. */
| 'HANDLE'
/** Sort by the `id` value. */
| 'ID'
/**
* Sort by relevance to the search terms when the `query` parameter is specified on the connection.
* Don't use this sort key when no search query is specified.
*
*/
| 'RELEVANCE'
/** Sort by the `title` value. */
| 'TITLE';
/**
* The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets).
*
*/
export type Brand = {
__typename?: 'Brand';
/** The colors of the store's brand. */
colors: BrandColors;
/** The store's cover image. */
coverImage?: Maybe<MediaImage>;
/** The store's default logo. */
logo?: Maybe<MediaImage>;
/** The store's short description. */
shortDescription?: Maybe<Scalars['String']['output']>;
/** The store's slogan. */
slogan?: Maybe<Scalars['String']['output']>;
/** The store's preferred logo for square UI elements. */
squareLogo?: Maybe<MediaImage>;
};
/**
* A group of related colors for the shop's brand.
*
*/
export type BrandColorGroup = {
__typename?: 'BrandColorGroup';
/** The background color. */
background?: Maybe<Scalars['Color']['output']>;
/** The foreground color. */
foreground?: Maybe<Scalars['Color']['output']>;
};
/**
* The colors of the shop's brand.
*
*/
export type BrandColors = {
__typename?: 'BrandColors';
/** The shop's primary brand colors. */
primary: Array<BrandColorGroup>;
/** The shop's secondary brand colors. */
secondary: Array<BrandColorGroup>;
};
/**
* The input fields for obtaining the buyer's identity.
*
*/
export type BuyerInput = {
/** The identifier of the company location. */
companyLocationId?: InputMaybe<Scalars['ID']['input']>;
/** The storefront customer access token retrieved from the [Customer Accounts API](https://shopify.dev/docs/api/customer/reference/mutations/storefrontCustomerAccessTokenCreate). */
customerAccessToken: Scalars['String']['input'];
};
/** Card brand, such as Visa or Mastercard, which can be used for payments. */
export type CardBrand =
/** American Express. */
| 'AMERICAN_EXPRESS'
/** Diners Club. */
| 'DINERS_CLUB'
/** Discover. */
| 'DISCOVER'
/** JCB. */
| 'JCB'
/** Mastercard. */
| 'MASTERCARD'
/** Visa. */
| 'VISA';
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type Cart = HasMetafields &
Node & {
__typename?: 'Cart';
/** An attribute associated with the cart. */
attribute?: Maybe<Attribute>;
/** The attributes associated with the cart. Attributes are represented as key-value pairs. */
attributes: Array<Attribute>;
/** Information about the buyer that's interacting with the cart. */
buyerIdentity: CartBuyerIdentity;
/** The URL of the checkout for the cart. */
checkoutUrl: Scalars['URL']['output'];
/** The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). */
cost: CartCost;
/** The date and time when the cart was created. */
createdAt: Scalars['DateTime']['output'];
/**
* The delivery groups available for the cart, based on the buyer identity default
* delivery address preference or the default address of the logged-in customer.
*
*/
deliveryGroups: CartDeliveryGroupConnection;
/** The discounts that have been applied to the entire cart. */
discountAllocations: Array<
| CartAutomaticDiscountAllocation
| CartCodeDiscountAllocation
| CartCustomDiscountAllocation
>;
/** The case-insensitive discount codes that the customer added at checkout. */
discountCodes: Array<CartDiscountCode>;
/**
* The estimated costs that the buyer will pay at checkout. The estimated costs are subject to change and changes will be reflected at checkout. The `estimatedCost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
* @deprecated Use `cost` instead.
*/
estimatedCost: CartEstimatedCost;
/** A globally-unique ID. */
id: Scalars['ID']['output'];
/** A list of lines containing information about the items the customer intends to purchase. */
lines: BaseCartLineConnection;
/** Returns a metafield found by namespace and key. */
metafield?: Maybe<Metafield>;
/** The metafields associated with the resource matching the supplied list of namespaces and keys. */
metafields: Array<Maybe<Metafield>>;
/** A note that's associated with the cart. For example, the note can be a personalized message to the buyer. */
note?: Maybe<Scalars['String']['output']>;
/** The total number of items in the cart. */
totalQuantity: Scalars['Int']['output'];
/** The date and time when the cart was updated. */
updatedAt: Scalars['DateTime']['output'];
};
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type CartAttributeArgs = {
key: Scalars['String']['input'];
};
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type CartDeliveryGroupsArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
reverse?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type CartLinesArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
reverse?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type CartMetafieldArgs = {
key: Scalars['String']['input'];
namespace?: InputMaybe<Scalars['String']['input']>;
};
/**
* A cart represents the merchandise that a buyer intends to purchase,
* and the estimated cost associated with the cart. Learn how to
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* during a customer's session.
*
*/
export type CartMetafieldsArgs = {
identifiers: Array<HasMetafieldsIdentifier>;
};
/** Return type for `cartAttributesUpdate` mutation. */
export type CartAttributesUpdatePayload = {
__typename?: 'CartAttributesUpdatePayload';
/** The updated cart. */
cart?: Maybe<Cart>;
/** The list of errors that occurred from executing the mutation. */
userErrors: Array<CartUserError>;
};
/** The discounts automatically applied to the cart line based on prerequisites that have been met. */
export type CartAutomaticDiscountAllocation = CartDiscountAllocation & {
__typename?: 'CartAutomaticDiscountAllocation';
/** The discounted amount that has been applied to the cart line. */
discountedAmount: MoneyV2;
/** The title of the allocated discount. */
title: Scalars['String']['output'];
};
/** Represents information about the buyer that is interacting with the cart. */
export type CartBuyerIdentity = {
__typename?: 'CartBuyerIdentity';
/** The country where the buyer is located. */
countryCode?: Maybe<CountryCode>;
/** The customer account associated with the cart. */
customer?: Maybe<Customer>;
/**
* An ordered set of delivery addresses tied to the buyer that is interacting with the cart.
* The rank of the preferences is determined by the order of the addresses in the array. Preferences
* can be used to populate relevant fields in the checkout flow.
*
*/
deliveryAddressPreferences: Array<DeliveryAddress>;
/** The email address of the buyer that's interacting with the cart. */
email?: Maybe<Scalars['String']['output']>;
/** The phone number of the buyer that's interacting with the cart. */
phone?: Maybe<Scalars['String']['output']>;
/** The purchasing company associated with the cart. */
purchasingCompany?: Maybe<PurchasingCompany>;
/**
* A set of wallet preferences tied to the buyer that is interacting with the cart.
* Preferences can be used to populate relevant payment fields in the checkout flow.
*
*/
walletPreferences: Array<Scalars['String']['output']>;
};
/**
* Specifies the input fields to update the buyer information associated with a cart.
* Buyer identity is used to determine
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
* and should match the customer's shipping address.
*
*/
export type CartBuyerIdentityInput = {
/** The company location of the buyer that is interacting with the cart. */
companyLocationId?: InputMaybe<Scalars['ID']['input']>;
/** The country where the buyer is located. */
countryCode?: InputMaybe<CountryCode>;
/** The access token used to identify the customer associated with the cart. */
customerAccessToken?: InputMaybe<Scalars['String']['input']>;
/**
* An ordered set of delivery addresses tied to the buyer that is interacting with the cart.
* The rank of the preferences is determined by the order of the addresses in the array. Preferences
* can be used to populate relevant fields in the checkout flow.
*
* The input must not contain more than `250` values.
*/
deliveryAddressPreferences?: InputMaybe<Array<DeliveryAddressInput>>;
/** The email address of the buyer that is interacting with the cart. */
email?: InputMaybe<Scalars['String']['input']>;
/** The phone number of the buyer that is interacting with the cart. */
phone?: InputMaybe<Scalars['String']['input']>;
/**
* A set of wallet preferences tied to the buyer that is interacting with the cart.
* Preferences can be used to populate relevant payment fields in the checkout flow.
* Accepted value: `["shop_pay"]`.
*
* The input must not contain more than `250` values.
*/
walletPreferences?: InputMaybe<Array<Scalars['String']['input']>>;
};
/** Return type for `cartBuyerIdentityUpdate` mutation. */
export type CartBuyerIdentityUpdatePayload = {
__typename?: 'CartBuyerIdentityUpdatePayload';
/** The updated cart. */
cart?: Maybe<Cart>;
/** The list of errors that occurred from executing the mutation. */
userErrors: Array<CartUserError>;
};
/**
* Represents how credit card details are provided for a direct payment.
*
*/
export type CartCardSource =
/**
* The credit card was provided by a third party and vaulted on their system.
* Using this value requires a separate permission from Shopify.
*
*/
'SAVED_CREDIT_CARD';
/** The discount that has been applied to the cart line using a discount code. */
export type CartCodeDiscountAllocation = CartDiscountAllocation & {
__typename?: 'CartCodeDiscountAllocation';
/** The code used to apply the discount. */
code: Scalars['String']['output'];
/** The discounted amount that has been applied to the cart line. */
discountedAmount: MoneyV2;
};
/** The completion action to checkout a cart. */
export type CartCompletionAction = CompletePaymentChallenge;
/** The required completion action to checkout a cart. */
export type CartCompletionActionRequired = {
__typename?: 'CartCompletionActionRequired';
/** The action required to complete the cart completion attempt. */
action?: Maybe<CartCompletionAction>;
/** The ID of the cart completion attempt. */
id: Scalars['String']['output'];
};
/** The result of a cart completion attempt. */
export type CartCompletionAttemptResult =
| CartCompletionActionRequired
| CartCompletionFailed
| CartCompletionProcessing
| CartCompletionSuccess;
/** A failed completion to checkout a cart. */
export type CartCompletionFailed = {
__typename?: 'CartCompletionFailed';
/** The errors that caused the checkout to fail. */
errors: Array<CompletionError>;
/** The ID of the cart completion attempt. */
id: Scalars['String']['output'];
};
/** A cart checkout completion that's still processing. */
export type CartCompletionProcessing = {
__typename?: 'CartCompletionProcessing';
/** The ID of the cart completion attempt. */
id: Scalars['String']['output'];
/** The number of milliseconds to wait before polling again. */
pollDelay: Scalars['Int']['output'];
};
/** A successful completion to checkout a cart and a created order. */
export type CartCompletionSuccess = {
__typename?: 'CartCompletionSuccess';
/** The date and time when the job completed. */
completedAt?: Maybe<Scalars['DateTime']['output']>;
/** The ID of the cart completion attempt. */
id: Scalars['String']['output'];
/** The ID of the order that's created in Shopify. */
orderId: Scalars['ID']['output'];
/** The URL of the order confirmation in Shopify. */
orderUrl: Scalars['URL']['output'];
};
/**
* The costs that the buyer will pay at checkout.
* The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
*
*/
export type CartCost = {
__typename?: 'CartCost';
/** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to `subtotalAmount`. */
checkoutChargeAmount: MoneyV2;
/** The amount, before taxes and cart-level discounts, for the customer to pay. */
subtotalAmount: MoneyV2;
/** Whether the subtotal amount is estimated. */
subtotalAmountEstimated: Scalars['Boolean']['output'];
/** The total amount for the customer to pay. */
totalAmount: MoneyV2;
/** Whether the total amount is estimated. */
totalAmountEstimated: Scalars['Boolean']['output'];
/** The duty amount for the customer to pay at checkout. */
totalDutyAmount?: Maybe<MoneyV2>;
/** Whether the total duty amount is estimated. */
totalDutyAmountEstimated: Scalars['Boolean']['output'];
/** The tax amount for the customer to pay at checkout. */
totalTaxAmount?: Maybe<MoneyV2>;
/** Whether the total tax amount is estimated. */
totalTaxAmountEstimated: Scalars['Boolean']['output'];
};
/** Return type for `cartCreate` mutation. */
export type CartCreatePayload = {
__typename?: 'CartCreatePayload';
/** The new cart. */
cart?: Maybe<Cart>;
/** The list of errors that occurred from executing the mutation. */
userErrors: Array<CartUserError>;
};
/** The discounts automatically applied to the cart line based on prerequisites that have been met. */
export type CartCustomDiscountAllocation = CartDiscountAllocation & {
__typename?: 'CartCustomDiscountAllocation';
/** The discounted amount that has been applied to the cart line. */
discountedAmount: MoneyV2;
/** The title of the allocated discount. */
title: Scalars['String']['output'];
};
/** Information about the options available for one or more line items to be delivered to a specific address. */
export type CartDeliveryGroup = {
__typename?: 'CartDeliveryGroup';
/** A list of cart lines for the delivery group. */
cartLines: BaseCartLineConnection;
/** The destination address for the delivery group. */
deliveryAddress: MailingAddress;
/** The delivery options available for the delivery group. */
deliveryOptions: Array<CartDeliveryOption>;
/** The type of merchandise in the delivery group. */
groupType: CartDeliveryGroupType;
/** The ID for the delivery group. */
id: Scalars['ID']['output'];
/** The selected delivery option for the delivery group. */
selectedDeliveryOption?: Maybe<CartDeliveryOption>;
};
/** Information about the options available for one or more line items to be delivered to a specific address. */
export type CartDeliveryGroupCartLinesArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
reverse?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* An auto-generated type for paginating through multiple CartDeliveryGroups.
*
*/
export type CartDeliveryGroupConnection = {
__typename?: 'CartDeliveryGroupConnection';
/** A list of edges. */
edges: Array<CartDeliveryGroupEdge>;
/** A list of the nodes contained in CartDeliveryGroupEdge. */
nodes: Array<CartDeliveryGroup>;
/** Information to aid in pagination. */
pageInfo: PageInfo;
};
/**
* An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination.
*
*/
export type CartDeliveryGroupEdge = {
__typename?: 'CartDeliveryGroupEdge';
/** A cursor for use in pagination. */
cursor: Scalars['String']['output'];
/** The item at the end of CartDeliveryGroupEdge. */
node: CartDeliveryGroup;
};
/**
* Defines what type of merchandise is in the delivery group.
*
*/
export type CartDeliveryGroupType =
/**
* The delivery group only contains merchandise that is either a one time purchase or a first delivery of
* subscription merchandise.
*
*/
| 'ONE_TIME_PURCHASE'
/** The delivery group only contains subscription merchandise. */
| 'SUBSCRIPTION';
/** Information about a delivery option. */
export type CartDeliveryOption = {
__typename?: 'CartDeliveryOption';
/** The code of the delivery option. */
code?: Maybe<Scalars['String']['output']>;
/** The method for the delivery option. */
deliveryMethodType: DeliveryMethodType;
/** The description of the delivery option. */
description?: Maybe<Scalars['String']['output']>;
/** The estimated cost for the delivery option. */
estimatedCost: MoneyV2;
/** The unique identifier of the delivery option. */
handle: Scalars['String']['output'];
/** The title of the delivery option. */
title?: Maybe<Scalars['String']['output']>;
};
/**
* The input fields for submitting direct payment method information for checkout.
*
*/
export type CartDirectPaymentMethodInput = {
/** The customer's billing address. */
billingAddress: MailingAddressInput;
/** The source of the credit card payment. */
cardSource?: InputMaybe<CartCardSource>;
/** The session ID for the direct payment method used to create the payment. */
sessionId: Scalars['String']['input'];
};
/** The discounts that have been applied to the cart line. */
export type CartDiscountAllocation = {
/** The discounted amount that has been applied to the cart line. */
discountedAmount: MoneyV2;
};
/** The discount codes applied to the cart. */
export type CartDiscountCode = {
__typename?: 'CartDiscountCode';
/** Whether the discount code is applicable to the cart's current contents. */
applicable: Scalars['Boolean']['output'];
/** The code for the discount. */
code: Scalars['String']['output'];
};
/** Return type for `cartDiscountCodesUpdate` mutation. */
export type CartDiscountCodesUpdatePayload = {
__typename?: 'CartDiscountCodesUpdatePayload';
/** The updated cart. */
cart?: Maybe<Cart>;
/** The list of errors that occurred from executing the mutation. */
userErrors: Array<CartUserError>;
};
/** Possible error codes that can be returned by `CartUserError`. */
export type CartErrorCode =
/** The specified address field contains emojis. */
| 'ADDRESS_FIELD_CONTAINS_EMOJIS'
/** The specified address field contains HTML tags. */
| 'ADDRESS_FIELD_CONTAINS_HTML_TAGS'
/** The specified address field contains a URL. */
| 'ADDRESS_FIELD_CONTAINS_URL'
/** The specified address field does not match the expected pattern. */
| 'ADDRESS_FIELD_DOES_NOT_MATCH_EXPECTED_PATTERN'
/** The specified address field is required. */
| 'ADDRESS_FIELD_IS_REQUIRED'
/** The specified address field is too long. */
| 'ADDRESS_FIELD_IS_TOO_LONG'
/** The input value is invalid. */
| 'INVALID'
/** Company location not found or not allowed. */
| 'INVALID_COMPANY_LOCATION'