@shopify/hydrogen 2024.7.8 → 2024.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * THIS FILE IS AUTO-GENERATED, DO NOT EDIT
3
- * Based on Customer Account API 2024-07
3
+ * Based on Customer Account API 2024-10
4
4
  * 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`.
5
5
  * Except custom Scalars, which are defined in the `codegen.ts` file
6
6
  */
@@ -72,18 +72,11 @@ export type AddressFormFieldMode =
72
72
  /**
73
73
  * Indicates that the form field should be hidden from the UI.
74
74
  * Any values provided by the client will be ignored by the backend.
75
- *
76
75
  */
77
76
  | 'IGNORED'
78
- /**
79
- * Indicates that the form field is visible in the UI and can be left empty.
80
- *
81
- */
77
+ /** Indicates that the form field is visible in the UI and can be left empty. */
82
78
  | 'OPTIONAL'
83
- /**
84
- * Indicates that the form field is visible in the UI and requires a non-empty value.
85
- *
86
- */
79
+ /** Indicates that the form field is visible in the UI and requires a non-empty value. */
87
80
  | 'REQUIRED';
88
81
 
89
82
  /** The settings for the address form. */
@@ -178,10 +171,7 @@ export type ApplePaySessionCreatePayload = {
178
171
  body?: Maybe<Scalars['String']['output']>;
179
172
  /** The ID for the created session. */
180
173
  id?: Maybe<Scalars['String']['output']>;
181
- /**
182
- * Whether the session is ready. The `body` field is `null` while this value is `false`.
183
- *
184
- */
174
+ /** Whether the session is ready. The `body` field is `null` while this value is `false`. */
185
175
  ready?: Maybe<Scalars['Boolean']['output']>;
186
176
  /** The list of errors that occurred from executing the mutation. */
187
177
  userErrors: Array<ApplePaySessionUserError>;
@@ -227,19 +217,16 @@ export type AppliedGiftCard = Node & {
227
217
  presentmentAmountUsed: MoneyV2;
228
218
  };
229
219
 
230
- /** Represents a generic custom attribute. */
220
+ /** Represents a generic custom attribute, such as whether an order is a customer's first. */
231
221
  export type Attribute = {
232
222
  __typename?: 'Attribute';
233
- /** Key or name of the attribute. */
223
+ /** The key or name of the attribute. For example, `"customersFirstOrder"`. */
234
224
  key: Scalars['String']['output'];
235
- /** Value of the attribute. */
225
+ /** The value of the attribute. For example, `"true"`. */
236
226
  value?: Maybe<Scalars['String']['output']>;
237
227
  };
238
228
 
239
- /**
240
- * Captures the intentions of a discount that was automatically applied.
241
- *
242
- */
229
+ /** Captures the intentions of a discount that was automatically applied. */
243
230
  export type AutomaticDiscountApplication = DiscountApplication & {
244
231
  __typename?: 'AutomaticDiscountApplication';
245
232
  /** The method by which the discount's value is allocated to its entitled items. */
@@ -261,17 +248,13 @@ export type AvailableShippingRates = {
261
248
  * Whether the shipping rates are ready.
262
249
  * The `shippingRates` field is `null` when this value is `false`.
263
250
  * This field should be polled until its value becomes `true`.
264
- *
265
251
  */
266
252
  ready: Scalars['Boolean']['output'];
267
253
  /** The fetched shipping rates. `null` until the `ready` field is `true`. */
268
254
  shippingRates?: Maybe<Array<ShippingRate>>;
269
255
  };
270
256
 
271
- /**
272
- * The input fields required for updating a business contact.
273
- *
274
- */
257
+ /** The input fields required for updating a business contact. */
275
258
  export type BusinessContactUpdateInput = {
276
259
  /** The first name of the business contact. */
277
260
  firstName?: InputMaybe<Scalars['String']['input']>;
@@ -339,10 +322,7 @@ export type BusinessLocationCreditCardAddPayload = {
339
322
  __typename?: 'BusinessLocationCreditCardAddPayload';
340
323
  /** The newly added credit card. */
341
324
  creditCard?: Maybe<CustomerCreditCard>;
342
- /**
343
- * The URL to redirect the customer to for completing the 3D Secure payment flow.
344
- *
345
- */
325
+ /** The URL to redirect the customer to for completing the 3D Secure payment flow. */
346
326
  nextActionUrl?: Maybe<Scalars['URL']['output']>;
347
327
  /** If the card verification result is processing. When this is true, credit_card will be null. */
348
328
  processing?: Maybe<Scalars['Boolean']['output']>;
@@ -373,10 +353,11 @@ export type BusinessLocationPaymentInstrumentRemovePayload = {
373
353
  /** The configuration for the buyer's checkout. */
374
354
  export type BuyerExperienceConfiguration = {
375
355
  __typename?: 'BuyerExperienceConfiguration';
356
+ /** The deposit amount required for the order. */
357
+ deposit?: Maybe<DepositConfiguration>;
376
358
  /**
377
359
  * Whether the buyer must pay at checkout or
378
360
  * can choose to pay at checkout or pay later using net terms.
379
- *
380
361
  */
381
362
  payNowOnly: Scalars['Boolean']['output'];
382
363
  /** The merchant configured payment terms. */
@@ -392,7 +373,7 @@ export type CardPaymentDetails = {
392
373
  last4?: Maybe<Scalars['String']['output']>;
393
374
  };
394
375
 
395
- /** A container for information required to checkout items and pay. */
376
+ /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
396
377
  export type Checkout = Node & {
397
378
  __typename?: 'Checkout';
398
379
  /** The gift cards used on the checkout. */
@@ -401,7 +382,6 @@ export type Checkout = Node & {
401
382
  * The available shipping rates for this Checkout.
402
383
  * Should only be used when checkout `requiresShipping` is `true` and
403
384
  * the shipping address is valid.
404
- *
405
385
  */
406
386
  availableShippingRates?: Maybe<AvailableShippingRates>;
407
387
  /** The date and time when the checkout was created. */
@@ -421,7 +401,6 @@ export type Checkout = Node & {
421
401
  /**
422
402
  * The sum of all the prices of all the items in the checkout,
423
403
  * excluding duties, taxes, shipping, and discounts.
424
- *
425
404
  */
426
405
  lineItemsSubtotalPrice: MoneyV2;
427
406
  /** The note associated with the checkout. */
@@ -433,17 +412,13 @@ export type Checkout = Node & {
433
412
  * have asynchronous operations that can take time to finish. If you want
434
413
  * to complete a checkout or ensure all the fields are populated and up to
435
414
  * date, polling is required until the value is true.
436
- *
437
415
  */
438
416
  ready: Scalars['Boolean']['output'];
439
417
  /** Whether the fulfillment requires shipping. */
440
418
  requiresShipping: Scalars['Boolean']['output'];
441
419
  /** The address where the line items will be shipped. */
442
420
  shippingAddress?: Maybe<CustomerMailingAddress>;
443
- /**
444
- * The discounts allocated to the shipping line by discount applications.
445
- *
446
- */
421
+ /** The discounts allocated to the shipping line by discount applications. */
447
422
  shippingDiscountAllocations: Array<DiscountAllocation>;
448
423
  /** The selected shipping rate, transitioned to a `shipping_line` object. */
449
424
  shippingLine?: Maybe<ShippingRate>;
@@ -460,7 +435,6 @@ export type Checkout = Node & {
460
435
  /**
461
436
  * The sum of all the prices of all the items in the checkout,
462
437
  * duties, taxes, and discounts included.
463
- *
464
438
  */
465
439
  totalPrice: MoneyV2;
466
440
  /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */
@@ -469,7 +443,7 @@ export type Checkout = Node & {
469
443
  webUrl: Scalars['URL']['output'];
470
444
  };
471
445
 
472
- /** A container for information required to checkout items and pay. */
446
+ /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
473
447
  export type CheckoutDiscountApplicationsArgs = {
474
448
  after?: InputMaybe<Scalars['String']['input']>;
475
449
  before?: InputMaybe<Scalars['String']['input']>;
@@ -478,7 +452,7 @@ export type CheckoutDiscountApplicationsArgs = {
478
452
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
479
453
  };
480
454
 
481
- /** A container for information required to checkout items and pay. */
455
+ /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
482
456
  export type CheckoutLineItemsArgs = {
483
457
  after?: InputMaybe<Scalars['String']['input']>;
484
458
  before?: InputMaybe<Scalars['String']['input']>;
@@ -506,27 +480,21 @@ export type CheckoutLineItem = Node & {
506
480
  variantTitle?: Maybe<Scalars['String']['output']>;
507
481
  };
508
482
 
509
- /**
510
- * An auto-generated type for paginating through multiple CheckoutLineItems.
511
- *
512
- */
483
+ /** An auto-generated type for paginating through multiple CheckoutLineItems. */
513
484
  export type CheckoutLineItemConnection = {
514
485
  __typename?: 'CheckoutLineItemConnection';
515
- /** A list of edges. */
486
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
516
487
  edges: Array<CheckoutLineItemEdge>;
517
- /** A list of the nodes contained in CheckoutLineItemEdge. */
488
+ /** A list of nodes that are contained in CheckoutLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
518
489
  nodes: Array<CheckoutLineItem>;
519
- /** Information to aid in pagination. */
490
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
520
491
  pageInfo: PageInfo;
521
492
  };
522
493
 
523
- /**
524
- * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination.
525
- *
526
- */
494
+ /** An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. */
527
495
  export type CheckoutLineItemEdge = {
528
496
  __typename?: 'CheckoutLineItemEdge';
529
- /** A cursor for use in pagination. */
497
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
530
498
  cursor: Scalars['String']['output'];
531
499
  /** The item at the end of CheckoutLineItemEdge. */
532
500
  node: CheckoutLineItem;
@@ -549,7 +517,6 @@ export type Company = HasMetafields &
549
517
  /**
550
518
  * The metafields associated with the resource matching the
551
519
  * supplied list of namespaces and keys.
552
- *
553
520
  */
554
521
  metafields: Array<Maybe<Metafield>>;
555
522
  /** The name of the company. */
@@ -604,7 +571,7 @@ export type CompanyOrdersArgs = {
604
571
  sortKey?: InputMaybe<OrderByCompanySortKeys>;
605
572
  };
606
573
 
607
- /** The address of a company location, either billing or shipping. */
574
+ /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
608
575
  export type CompanyAddress = Node & {
609
576
  __typename?: 'CompanyAddress';
610
577
  /** The first line of the address. It is typically the street address or PO Box number. */
@@ -626,7 +593,6 @@ export type CompanyAddress = Node & {
626
593
  /**
627
594
  * The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601))
628
595
  * when the company address was created.
629
- *
630
596
  */
631
597
  createdAt: Scalars['DateTime']['output'];
632
598
  /** The first name of the recipient. */
@@ -645,10 +611,7 @@ export type CompanyAddress = Node & {
645
611
  latitude?: Maybe<Scalars['Float']['output']>;
646
612
  /** The longitude coordinate of the address. */
647
613
  longitude?: Maybe<Scalars['Float']['output']>;
648
- /**
649
- * The unique phone number of the customer, formatted using the E.164 standard, for example, _+16135551111_.
650
- *
651
- */
614
+ /** The unique phone number of the customer, formatted using the E.164 standard, for example, _+16135551111_. */
652
615
  phone?: Maybe<Scalars['String']['output']>;
653
616
  /** The region of the address, such as the province, state, or district. */
654
617
  province?: Maybe<Scalars['String']['output']>;
@@ -659,7 +622,6 @@ export type CompanyAddress = Node & {
659
622
  /**
660
623
  * The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601))
661
624
  * when the company address was last updated.
662
- *
663
625
  */
664
626
  updatedAt: Scalars['DateTime']['output'];
665
627
  /** The zip or postal code of the address. */
@@ -668,13 +630,13 @@ export type CompanyAddress = Node & {
668
630
  zoneCode?: Maybe<Scalars['String']['output']>;
669
631
  };
670
632
 
671
- /** The address of a company location, either billing or shipping. */
633
+ /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
672
634
  export type CompanyAddressFormattedArgs = {
673
635
  withCompanyName?: InputMaybe<Scalars['Boolean']['input']>;
674
636
  withName?: InputMaybe<Scalars['Boolean']['input']>;
675
637
  };
676
638
 
677
- /** The address of a company location, either billing or shipping. */
639
+ /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
678
640
  export type CompanyAddressFormattedAddressArgs = {
679
641
  withCompanyName?: InputMaybe<Scalars['Boolean']['input']>;
680
642
  withName?: InputMaybe<Scalars['Boolean']['input']>;
@@ -776,33 +738,27 @@ export type CompanyContactOrdersArgs = {
776
738
  sortKey?: InputMaybe<OrderByContactSortKeys>;
777
739
  };
778
740
 
779
- /**
780
- * An auto-generated type for paginating through multiple CompanyContacts.
781
- *
782
- */
741
+ /** An auto-generated type for paginating through multiple CompanyContacts. */
783
742
  export type CompanyContactConnection = {
784
743
  __typename?: 'CompanyContactConnection';
785
- /** A list of edges. */
744
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
786
745
  edges: Array<CompanyContactEdge>;
787
- /** A list of the nodes contained in CompanyContactEdge. */
746
+ /** A list of nodes that are contained in CompanyContactEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
788
747
  nodes: Array<CompanyContact>;
789
- /** Information to aid in pagination. */
748
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
790
749
  pageInfo: PageInfo;
791
750
  };
792
751
 
793
- /**
794
- * An auto-generated type which holds one CompanyContact and a cursor during pagination.
795
- *
796
- */
752
+ /** An auto-generated type which holds one CompanyContact and a cursor during pagination. */
797
753
  export type CompanyContactEdge = {
798
754
  __typename?: 'CompanyContactEdge';
799
- /** A cursor for use in pagination. */
755
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
800
756
  cursor: Scalars['String']['output'];
801
757
  /** The item at the end of CompanyContactEdge. */
802
758
  node: CompanyContact;
803
759
  };
804
760
 
805
- /** A role for a company contact. */
761
+ /** A role for a company contact. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
806
762
  export type CompanyContactRole = Node & {
807
763
  __typename?: 'CompanyContactRole';
808
764
  /** A globally-unique ID. */
@@ -815,7 +771,7 @@ export type CompanyContactRole = Node & {
815
771
  resourcePermissions: Array<ResourcePermission>;
816
772
  };
817
773
 
818
- /** A role for a company contact. */
774
+ /** A role for a company contact. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
819
775
  export type CompanyContactRoleResourcePermissionArgs = {
820
776
  resource: ResourceType;
821
777
  };
@@ -831,27 +787,21 @@ export type CompanyContactRoleAssignment = Node & {
831
787
  role: CompanyContactRole;
832
788
  };
833
789
 
834
- /**
835
- * An auto-generated type for paginating through multiple CompanyContactRoleAssignments.
836
- *
837
- */
790
+ /** An auto-generated type for paginating through multiple CompanyContactRoleAssignments. */
838
791
  export type CompanyContactRoleAssignmentConnection = {
839
792
  __typename?: 'CompanyContactRoleAssignmentConnection';
840
- /** A list of edges. */
793
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
841
794
  edges: Array<CompanyContactRoleAssignmentEdge>;
842
- /** A list of the nodes contained in CompanyContactRoleAssignmentEdge. */
795
+ /** A list of nodes that are contained in CompanyContactRoleAssignmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
843
796
  nodes: Array<CompanyContactRoleAssignment>;
844
- /** Information to aid in pagination. */
797
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
845
798
  pageInfo: PageInfo;
846
799
  };
847
800
 
848
- /**
849
- * An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination.
850
- *
851
- */
801
+ /** An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination. */
852
802
  export type CompanyContactRoleAssignmentEdge = {
853
803
  __typename?: 'CompanyContactRoleAssignmentEdge';
854
- /** A cursor for use in pagination. */
804
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
855
805
  cursor: Scalars['String']['output'];
856
806
  /** The item at the end of CompanyContactRoleAssignmentEdge. */
857
807
  node: CompanyContactRoleAssignment;
@@ -868,7 +818,6 @@ export type CompanyContactRoleAssignmentSortKeys =
868
818
  /**
869
819
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
870
820
  * Don't use this sort key when no search query is specified.
871
- *
872
821
  */
873
822
  | 'RELEVANCE'
874
823
  /** Sort by the `updated_at` value. */
@@ -891,7 +840,6 @@ export type CompanyContactSortKeys =
891
840
  /**
892
841
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
893
842
  * Don't use this sort key when no search query is specified.
894
- *
895
843
  */
896
844
  | 'RELEVANCE'
897
845
  /** Sort by the `title` value. */
@@ -933,7 +881,6 @@ export type CompanyLocation = HasMetafields &
933
881
  /**
934
882
  * The metafields associated with the resource matching the
935
883
  * supplied list of namespaces and keys.
936
- *
937
884
  */
938
885
  metafields: Array<Maybe<Metafield>>;
939
886
  /** The name of the company location. */
@@ -1030,27 +977,21 @@ export type CompanyLocationAssignAddressPayload = {
1030
977
  userErrors: Array<BusinessCustomerUserError>;
1031
978
  };
1032
979
 
1033
- /**
1034
- * An auto-generated type for paginating through multiple CompanyLocations.
1035
- *
1036
- */
980
+ /** An auto-generated type for paginating through multiple CompanyLocations. */
1037
981
  export type CompanyLocationConnection = {
1038
982
  __typename?: 'CompanyLocationConnection';
1039
- /** A list of edges. */
983
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
1040
984
  edges: Array<CompanyLocationEdge>;
1041
- /** A list of the nodes contained in CompanyLocationEdge. */
985
+ /** A list of nodes that are contained in CompanyLocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
1042
986
  nodes: Array<CompanyLocation>;
1043
- /** Information to aid in pagination. */
987
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
1044
988
  pageInfo: PageInfo;
1045
989
  };
1046
990
 
1047
- /**
1048
- * An auto-generated type which holds one CompanyLocation and a cursor during pagination.
1049
- *
1050
- */
991
+ /** An auto-generated type which holds one CompanyLocation and a cursor during pagination. */
1051
992
  export type CompanyLocationEdge = {
1052
993
  __typename?: 'CompanyLocationEdge';
1053
- /** A cursor for use in pagination. */
994
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
1054
995
  cursor: Scalars['String']['output'];
1055
996
  /** The item at the end of CompanyLocationEdge. */
1056
997
  node: CompanyLocation;
@@ -1071,44 +1012,43 @@ export type CompanyLocationSortKeys =
1071
1012
  /**
1072
1013
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
1073
1014
  * Don't use this sort key when no search query is specified.
1074
- *
1075
1015
  */
1076
1016
  | 'RELEVANCE'
1077
1017
  /** Sort by the `updated_at` value. */
1078
1018
  | 'UPDATED_AT';
1079
1019
 
1080
- /**
1081
- * Defines the extent of locations for which a contact holds permissions on a resource.
1082
- *
1083
- */
1020
+ /** Defines the extent of locations for which a contact holds permissions on a resource. */
1084
1021
  export type ContactPermissionLocationScopeType =
1085
- /**
1086
- * The contact has permission on all locations.
1087
- *
1088
- */
1022
+ /** The contact has permission on all locations. */
1089
1023
  | 'ALL'
1090
- /**
1091
- * The contact has permission for at least one location.
1092
- *
1093
- */
1024
+ /** The contact has permission for at least one location. */
1094
1025
  | 'ANY'
1095
- /**
1096
- * The contact has no permission on any location.
1097
- *
1098
- */
1026
+ /** The contact has no permission on any location. */
1099
1027
  | 'NONE'
1100
- /**
1101
- * The contact has permission on only one location.
1102
- *
1103
- */
1028
+ /** The contact has permission on only one location. */
1104
1029
  | 'ONE';
1105
1030
 
1031
+ /** Details for count of elements. */
1032
+ export type Count = {
1033
+ __typename?: 'Count';
1034
+ /** The count of elements. */
1035
+ count: Scalars['Int']['output'];
1036
+ /** The count's precision, or the exactness of the value. */
1037
+ precision: CountPrecision;
1038
+ };
1039
+
1040
+ /** The precision of the value returned by a count field. */
1041
+ export type CountPrecision =
1042
+ /** The count is at least the value. A limit was imposed and reached. */
1043
+ | 'AT_LEAST'
1044
+ /** The count is exactly the value. */
1045
+ | 'EXACT';
1046
+
1106
1047
  /**
1107
1048
  * The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.
1108
1049
  * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision
1109
1050
  * of another country. For example, the territories associated with Spain are represented by the country code `ES`,
1110
1051
  * and the territories associated with the United States of America are represented by the country code `US`.
1111
- *
1112
1052
  */
1113
1053
  export type CountryCode =
1114
1054
  /** Ascension Island. */
@@ -1642,7 +1582,6 @@ export type CropRegion =
1642
1582
  /**
1643
1583
  * The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,
1644
1584
  * and non-standard codes.
1645
- *
1646
1585
  */
1647
1586
  export type CurrencyCode =
1648
1587
  /** United Arab Emirates Dirham (AED). */
@@ -1968,7 +1907,7 @@ export type CurrencyCode =
1968
1907
  /** Zambian Kwacha (ZMW). */
1969
1908
  | 'ZMW';
1970
1909
 
1971
- /** Represents the personal information of a customer. */
1910
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
1972
1911
  export type Customer = HasMetafields &
1973
1912
  HasStoreCreditAccounts &
1974
1913
  Node & {
@@ -1989,10 +1928,7 @@ export type Customer = HasMetafields &
1989
1928
  creditCards: CustomerCreditCardConnection;
1990
1929
  /** The default address of the customer. */
1991
1930
  defaultAddress?: Maybe<CustomerAddress>;
1992
- /**
1993
- * The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number.
1994
- *
1995
- */
1931
+ /** The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number. */
1996
1932
  displayName: Scalars['String']['output'];
1997
1933
  /** The Draft Orders associated with the customer. */
1998
1934
  draftOrders: DraftOrderConnection;
@@ -2013,7 +1949,6 @@ export type Customer = HasMetafields &
2013
1949
  /**
2014
1950
  * The metafields associated with the resource matching the
2015
1951
  * supplied list of namespaces and keys.
2016
- *
2017
1952
  */
2018
1953
  metafields: Array<Maybe<Metafield>>;
2019
1954
  /** The orders associated with the customer. */
@@ -2036,7 +1971,7 @@ export type Customer = HasMetafields &
2036
1971
  taxExemptionsDetails: Array<TaxExemptionDetails>;
2037
1972
  };
2038
1973
 
2039
- /** Represents the personal information of a customer. */
1974
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2040
1975
  export type CustomerAddressesArgs = {
2041
1976
  after?: InputMaybe<Scalars['String']['input']>;
2042
1977
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2046,7 +1981,7 @@ export type CustomerAddressesArgs = {
2046
1981
  skipDefault?: InputMaybe<Scalars['Boolean']['input']>;
2047
1982
  };
2048
1983
 
2049
- /** Represents the personal information of a customer. */
1984
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2050
1985
  export type CustomerCompanyContactsArgs = {
2051
1986
  after?: InputMaybe<Scalars['String']['input']>;
2052
1987
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2055,12 +1990,12 @@ export type CustomerCompanyContactsArgs = {
2055
1990
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
2056
1991
  };
2057
1992
 
2058
- /** Represents the personal information of a customer. */
1993
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2059
1994
  export type CustomerCreditCardArgs = {
2060
1995
  id: Scalars['ID']['input'];
2061
1996
  };
2062
1997
 
2063
- /** Represents the personal information of a customer. */
1998
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2064
1999
  export type CustomerCreditCardsArgs = {
2065
2000
  after?: InputMaybe<Scalars['String']['input']>;
2066
2001
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2069,7 +2004,7 @@ export type CustomerCreditCardsArgs = {
2069
2004
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
2070
2005
  };
2071
2006
 
2072
- /** Represents the personal information of a customer. */
2007
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2073
2008
  export type CustomerDraftOrdersArgs = {
2074
2009
  after?: InputMaybe<Scalars['String']['input']>;
2075
2010
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2080,18 +2015,18 @@ export type CustomerDraftOrdersArgs = {
2080
2015
  sortKey?: InputMaybe<DraftOrderSortKeys>;
2081
2016
  };
2082
2017
 
2083
- /** Represents the personal information of a customer. */
2018
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2084
2019
  export type CustomerMetafieldArgs = {
2085
2020
  key: Scalars['String']['input'];
2086
2021
  namespace: Scalars['String']['input'];
2087
2022
  };
2088
2023
 
2089
- /** Represents the personal information of a customer. */
2024
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2090
2025
  export type CustomerMetafieldsArgs = {
2091
2026
  identifiers: Array<HasMetafieldsIdentifier>;
2092
2027
  };
2093
2028
 
2094
- /** Represents the personal information of a customer. */
2029
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2095
2030
  export type CustomerOrdersArgs = {
2096
2031
  after?: InputMaybe<Scalars['String']['input']>;
2097
2032
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2102,12 +2037,12 @@ export type CustomerOrdersArgs = {
2102
2037
  sortKey?: InputMaybe<OrderSortKeys>;
2103
2038
  };
2104
2039
 
2105
- /** Represents the personal information of a customer. */
2040
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2106
2041
  export type CustomerReturnArgs = {
2107
2042
  id: Scalars['ID']['input'];
2108
2043
  };
2109
2044
 
2110
- /** Represents the personal information of a customer. */
2045
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2111
2046
  export type CustomerStoreCreditAccountsArgs = {
2112
2047
  after?: InputMaybe<Scalars['String']['input']>;
2113
2048
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2116,12 +2051,12 @@ export type CustomerStoreCreditAccountsArgs = {
2116
2051
  query?: InputMaybe<Scalars['String']['input']>;
2117
2052
  };
2118
2053
 
2119
- /** Represents the personal information of a customer. */
2054
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2120
2055
  export type CustomerSubscriptionContractArgs = {
2121
2056
  id: Scalars['ID']['input'];
2122
2057
  };
2123
2058
 
2124
- /** Represents the personal information of a customer. */
2059
+ /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2125
2060
  export type CustomerSubscriptionContractsArgs = {
2126
2061
  after?: InputMaybe<Scalars['String']['input']>;
2127
2062
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2135,31 +2070,20 @@ export type CustomerSubscriptionContractsArgs = {
2135
2070
  /**
2136
2071
  * Represents a customer's mailing address.
2137
2072
  * For example, a customer's default address and an order's billing address are both mailing addresses.
2138
- *
2073
+ * Apps using the Customer Account API must meet the
2074
+ * protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).
2139
2075
  */
2140
2076
  export type CustomerAddress = Node & {
2141
2077
  __typename?: 'CustomerAddress';
2142
2078
  /** The first line of the address. Typically the street address or PO Box number. */
2143
2079
  address1?: Maybe<Scalars['String']['output']>;
2144
- /**
2145
- * The second line of the address. This is typically the apartment, suite, or unit number.
2146
- *
2147
- */
2080
+ /** The second line of the address. This is typically the apartment, suite, or unit number. */
2148
2081
  address2?: Maybe<Scalars['String']['output']>;
2149
- /**
2150
- * The name of the city, district, village, or town.
2151
- *
2152
- */
2082
+ /** The name of the city, district, village, or town. */
2153
2083
  city?: Maybe<Scalars['String']['output']>;
2154
- /**
2155
- * The name of the customer's company or organization.
2156
- *
2157
- */
2084
+ /** The name of the customer's company or organization. */
2158
2085
  company?: Maybe<Scalars['String']['output']>;
2159
- /**
2160
- * The name of the country.
2161
- *
2162
- */
2086
+ /** The name of the country. */
2163
2087
  country?: Maybe<Scalars['String']['output']>;
2164
2088
  /** The first name of the customer. */
2165
2089
  firstName?: Maybe<Scalars['String']['output']>;
@@ -2171,16 +2095,12 @@ export type CustomerAddress = Node & {
2171
2095
  id: Scalars['ID']['output'];
2172
2096
  /** The last name of the customer. */
2173
2097
  lastName?: Maybe<Scalars['String']['output']>;
2174
- /**
2175
- * The full name of the customer, based on firstName and lastName.
2176
- *
2177
- */
2098
+ /** The full name of the customer, based on firstName and lastName. */
2178
2099
  name?: Maybe<Scalars['String']['output']>;
2179
2100
  /**
2180
2101
  * The customer's unique phone number.
2181
2102
  *
2182
2103
  * Formatted using E.164 standard. For example, _+16135551111_.
2183
- *
2184
2104
  */
2185
2105
  phoneNumber?: Maybe<Scalars['String']['output']>;
2186
2106
  /** The region of the address, such as the province, state, or district. */
@@ -2189,7 +2109,6 @@ export type CustomerAddress = Node & {
2189
2109
  * The two-letter code for the country of the address.
2190
2110
  *
2191
2111
  * For example, US.
2192
- *
2193
2112
  */
2194
2113
  territoryCode?: Maybe<CountryCode>;
2195
2114
  /** The zip or postal code of the address. */
@@ -2198,7 +2117,6 @@ export type CustomerAddress = Node & {
2198
2117
  * The alphanumeric code for the region.
2199
2118
  *
2200
2119
  * For example, ON.
2201
- *
2202
2120
  */
2203
2121
  zoneCode?: Maybe<Scalars['String']['output']>;
2204
2122
  };
@@ -2206,24 +2124,22 @@ export type CustomerAddress = Node & {
2206
2124
  /**
2207
2125
  * Represents a customer's mailing address.
2208
2126
  * For example, a customer's default address and an order's billing address are both mailing addresses.
2209
- *
2127
+ * Apps using the Customer Account API must meet the
2128
+ * protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).
2210
2129
  */
2211
2130
  export type CustomerAddressFormattedArgs = {
2212
2131
  withCompany?: InputMaybe<Scalars['Boolean']['input']>;
2213
2132
  withName?: InputMaybe<Scalars['Boolean']['input']>;
2214
2133
  };
2215
2134
 
2216
- /**
2217
- * An auto-generated type for paginating through multiple CustomerAddresses.
2218
- *
2219
- */
2135
+ /** An auto-generated type for paginating through multiple CustomerAddresses. */
2220
2136
  export type CustomerAddressConnection = {
2221
2137
  __typename?: 'CustomerAddressConnection';
2222
- /** A list of edges. */
2138
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
2223
2139
  edges: Array<CustomerAddressEdge>;
2224
- /** A list of the nodes contained in CustomerAddressEdge. */
2140
+ /** A list of nodes that are contained in CustomerAddressEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
2225
2141
  nodes: Array<CustomerAddress>;
2226
- /** Information to aid in pagination. */
2142
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
2227
2143
  pageInfo: PageInfo;
2228
2144
  };
2229
2145
 
@@ -2245,13 +2161,10 @@ export type CustomerAddressDeletePayload = {
2245
2161
  userErrors: Array<UserErrorsCustomerAddressUserErrors>;
2246
2162
  };
2247
2163
 
2248
- /**
2249
- * An auto-generated type which holds one CustomerAddress and a cursor during pagination.
2250
- *
2251
- */
2164
+ /** An auto-generated type which holds one CustomerAddress and a cursor during pagination. */
2252
2165
  export type CustomerAddressEdge = {
2253
2166
  __typename?: 'CustomerAddressEdge';
2254
- /** A cursor for use in pagination. */
2167
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
2255
2168
  cursor: Scalars['String']['output'];
2256
2169
  /** The item at the end of CustomerAddressEdge. */
2257
2170
  node: CustomerAddress;
@@ -2277,7 +2190,6 @@ export type CustomerAddressInput = {
2277
2190
  * The country code, in ISO 3166-1 format. Accepts either a two-letter [alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),
2278
2191
  * a three-letter [alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3), or a three-digit [numeric code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric).
2279
2192
  * For example, `US`, `USA`, or `840` represents the United States.
2280
- *
2281
2193
  */
2282
2194
  territoryCode?: InputMaybe<Scalars['String']['input']>;
2283
2195
  /** The zip or postal code of the address. */
@@ -2285,7 +2197,6 @@ export type CustomerAddressInput = {
2285
2197
  /**
2286
2198
  * The alphanumeric code for the region of the address, such as the province, state, or district.
2287
2199
  * For example, 'ON' for Ontario, Canada.
2288
- *
2289
2200
  */
2290
2201
  zoneCode?: InputMaybe<Scalars['String']['input']>;
2291
2202
  };
@@ -2368,33 +2279,27 @@ export type CustomerCreditCardSubscriptionContractsArgs = {
2368
2279
  sortKey?: InputMaybe<SubscriptionContractsSortKeys>;
2369
2280
  };
2370
2281
 
2371
- /**
2372
- * An auto-generated type for paginating through multiple CustomerCreditCards.
2373
- *
2374
- */
2282
+ /** An auto-generated type for paginating through multiple CustomerCreditCards. */
2375
2283
  export type CustomerCreditCardConnection = {
2376
2284
  __typename?: 'CustomerCreditCardConnection';
2377
- /** A list of edges. */
2285
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
2378
2286
  edges: Array<CustomerCreditCardEdge>;
2379
- /** A list of the nodes contained in CustomerCreditCardEdge. */
2287
+ /** A list of nodes that are contained in CustomerCreditCardEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
2380
2288
  nodes: Array<CustomerCreditCard>;
2381
- /** Information to aid in pagination. */
2289
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
2382
2290
  pageInfo: PageInfo;
2383
2291
  };
2384
2292
 
2385
- /**
2386
- * An auto-generated type which holds one CustomerCreditCard and a cursor during pagination.
2387
- *
2388
- */
2293
+ /** An auto-generated type which holds one CustomerCreditCard and a cursor during pagination. */
2389
2294
  export type CustomerCreditCardEdge = {
2390
2295
  __typename?: 'CustomerCreditCardEdge';
2391
- /** A cursor for use in pagination. */
2296
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
2392
2297
  cursor: Scalars['String']['output'];
2393
2298
  /** The item at the end of CustomerCreditCardEdge. */
2394
2299
  node: CustomerCreditCard;
2395
2300
  };
2396
2301
 
2397
- /** An email address associated with a customer. */
2302
+ /** An email address associated with a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2398
2303
  export type CustomerEmailAddress = {
2399
2304
  __typename?: 'CustomerEmailAddress';
2400
2305
  /** The email address of the customer. */
@@ -2433,44 +2338,29 @@ export type CustomerEmailMarketingUnsubscribePayload = {
2433
2338
  /**
2434
2339
  * Represents a customer's mailing address.
2435
2340
  * For example, a customer's default address and an order's billing address are both mailing addresses.
2436
- *
2437
2341
  */
2438
2342
  export type CustomerMailingAddress = Node & {
2439
2343
  __typename?: 'CustomerMailingAddress';
2440
2344
  /** The first line of the address. Typically the street address or PO Box number. */
2441
2345
  address1?: Maybe<Scalars['String']['output']>;
2442
- /**
2443
- * The second line of the address. This is typically the apartment, suite, or unit number.
2444
- *
2445
- */
2346
+ /** The second line of the address. This is typically the apartment, suite, or unit number. */
2446
2347
  address2?: Maybe<Scalars['String']['output']>;
2447
- /**
2448
- * The name of the city, district, village, or town.
2449
- *
2450
- */
2348
+ /** The name of the city, district, village, or town. */
2451
2349
  city?: Maybe<Scalars['String']['output']>;
2452
- /**
2453
- * The name of the customer's company or organization.
2454
- *
2455
- */
2350
+ /** The name of the customer's company or organization. */
2456
2351
  company?: Maybe<Scalars['String']['output']>;
2457
- /**
2458
- * The name of the country.
2459
- *
2460
- */
2352
+ /** The name of the country. */
2461
2353
  country?: Maybe<Scalars['String']['output']>;
2462
2354
  /**
2463
2355
  * The two-letter code for the country of the address.
2464
2356
  *
2465
2357
  * For example, US.
2466
- *
2467
2358
  */
2468
2359
  countryCode?: Maybe<Scalars['String']['output']>;
2469
2360
  /**
2470
2361
  * The two-letter code for the country of the address.
2471
2362
  *
2472
2363
  * For example, US.
2473
- *
2474
2364
  */
2475
2365
  countryCodeV2?: Maybe<CountryCode>;
2476
2366
  /** Indicates whether the address is the default address or not. */
@@ -2489,23 +2379,18 @@ export type CustomerMailingAddress = Node & {
2489
2379
  latitude?: Maybe<Scalars['Float']['output']>;
2490
2380
  /** The longitude coordinate of the customer's address. */
2491
2381
  longitude?: Maybe<Scalars['Float']['output']>;
2492
- /**
2493
- * The full name of the customer, based on firstName and lastName.
2494
- *
2495
- */
2382
+ /** The full name of the customer, based on firstName and lastName. */
2496
2383
  name?: Maybe<Scalars['String']['output']>;
2497
2384
  /**
2498
2385
  * The customer's unique phone number.
2499
2386
  *
2500
2387
  * Formatted using E.164 standard. For example, _+16135551111_.
2501
- *
2502
2388
  */
2503
2389
  phone?: Maybe<Scalars['String']['output']>;
2504
2390
  /**
2505
2391
  * The customer's unique phone number.
2506
2392
  *
2507
2393
  * Formatted using E.164 standard. For example, _+16135551111_.
2508
- *
2509
2394
  */
2510
2395
  phoneNumber?: Maybe<Scalars['String']['output']>;
2511
2396
  /** The region of the address, such as the province, state, or district. */
@@ -2514,14 +2399,12 @@ export type CustomerMailingAddress = Node & {
2514
2399
  * The alphanumeric code for the region.
2515
2400
  *
2516
2401
  * For example, ON.
2517
- *
2518
2402
  */
2519
2403
  provinceCode?: Maybe<Scalars['String']['output']>;
2520
2404
  /**
2521
2405
  * The two-letter code for the country of the address.
2522
2406
  *
2523
2407
  * For example, US.
2524
- *
2525
2408
  */
2526
2409
  territoryCode?: Maybe<CountryCode>;
2527
2410
  /** Indicates whether the address was geolocated and is a valid address. The field returns `false` if the verification failed, or if the job to verify this address was never started. */
@@ -2532,7 +2415,6 @@ export type CustomerMailingAddress = Node & {
2532
2415
  * The alphanumeric code for the region.
2533
2416
  *
2534
2417
  * For example, ON.
2535
- *
2536
2418
  */
2537
2419
  zoneCode?: Maybe<Scalars['String']['output']>;
2538
2420
  };
@@ -2540,7 +2422,6 @@ export type CustomerMailingAddress = Node & {
2540
2422
  /**
2541
2423
  * Represents a customer's mailing address.
2542
2424
  * For example, a customer's default address and an order's billing address are both mailing addresses.
2543
- *
2544
2425
  */
2545
2426
  export type CustomerMailingAddressFormattedArgs = {
2546
2427
  withCompany?: InputMaybe<Scalars['Boolean']['input']>;
@@ -2574,12 +2455,11 @@ export type CustomerMailingAddressInput = {
2574
2455
  /**
2575
2456
  * The code for the region of the address, such as the province,
2576
2457
  * state, or district. For example, QC for Quebec, Canada.
2577
- *
2578
2458
  */
2579
2459
  zoneCode?: InputMaybe<Scalars['String']['input']>;
2580
2460
  };
2581
2461
 
2582
- /** Defines the phone number of the customer. */
2462
+ /** Defines the phone number of the customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2583
2463
  export type CustomerPhoneNumber = {
2584
2464
  __typename?: 'CustomerPhoneNumber';
2585
2465
  /** Indicates whether the customer has subscribed to SMS marketing material. */
@@ -2588,10 +2468,7 @@ export type CustomerPhoneNumber = {
2588
2468
  phoneNumber: Scalars['String']['output'];
2589
2469
  };
2590
2470
 
2591
- /**
2592
- * The input fields to update a customer's personal information.
2593
- *
2594
- */
2471
+ /** The input fields to update a customer's personal information. */
2595
2472
  export type CustomerUpdateInput = {
2596
2473
  /** The customer's first name. */
2597
2474
  firstName?: InputMaybe<Scalars['String']['input']>;
@@ -2615,10 +2492,17 @@ export type DeliveryOptionGroupType =
2615
2492
  /** A subscription. */
2616
2493
  | 'SUBSCRIPTION';
2617
2494
 
2618
- /**
2619
- * Represents an amount discounting the line that has been allocated by a discount.
2620
- *
2621
- */
2495
+ /** Configuration of the deposit. */
2496
+ export type DepositConfiguration = DepositPercentage;
2497
+
2498
+ /** A percentage deposit. */
2499
+ export type DepositPercentage = {
2500
+ __typename?: 'DepositPercentage';
2501
+ /** The percentage value of the deposit. */
2502
+ percentage: Scalars['Float']['output'];
2503
+ };
2504
+
2505
+ /** Represents an amount discounting the line that has been allocated by a discount. */
2622
2506
  export type DiscountAllocation = {
2623
2507
  __typename?: 'DiscountAllocation';
2624
2508
  /** The amount of discount allocated. */
@@ -2631,10 +2515,7 @@ export type DiscountAllocation = {
2631
2515
  | ScriptDiscountApplication;
2632
2516
  };
2633
2517
 
2634
- /**
2635
- * Captures the intentions of a discount source at the time of application.
2636
- *
2637
- */
2518
+ /** Captures the intentions of a discount source at the time of application. */
2638
2519
  export type DiscountApplication = {
2639
2520
  /** The method by which the discount's value is allocated to its entitled items. */
2640
2521
  allocationMethod: DiscountApplicationAllocationMethod;
@@ -2655,32 +2536,26 @@ export type DiscountApplicationAllocationMethod =
2655
2536
  /** The value is specifically applied onto a particular line. */
2656
2537
  | 'ONE';
2657
2538
 
2658
- /**
2659
- * An auto-generated type for paginating through multiple DiscountApplications.
2660
- *
2661
- */
2539
+ /** An auto-generated type for paginating through multiple DiscountApplications. */
2662
2540
  export type DiscountApplicationConnection = {
2663
2541
  __typename?: 'DiscountApplicationConnection';
2664
- /** A list of edges. */
2542
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
2665
2543
  edges: Array<DiscountApplicationEdge>;
2666
- /** A list of the nodes contained in DiscountApplicationEdge. */
2544
+ /** A list of nodes that are contained in DiscountApplicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
2667
2545
  nodes: Array<
2668
2546
  | AutomaticDiscountApplication
2669
2547
  | DiscountCodeApplication
2670
2548
  | ManualDiscountApplication
2671
2549
  | ScriptDiscountApplication
2672
2550
  >;
2673
- /** Information to aid in pagination. */
2551
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
2674
2552
  pageInfo: PageInfo;
2675
2553
  };
2676
2554
 
2677
- /**
2678
- * An auto-generated type which holds one DiscountApplication and a cursor during pagination.
2679
- *
2680
- */
2555
+ /** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */
2681
2556
  export type DiscountApplicationEdge = {
2682
2557
  __typename?: 'DiscountApplicationEdge';
2683
- /** A cursor for use in pagination. */
2558
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
2684
2559
  cursor: Scalars['String']['output'];
2685
2560
  /** The item at the end of DiscountApplicationEdge. */
2686
2561
  node:
@@ -2695,7 +2570,6 @@ export type DiscountApplicationEdge = {
2695
2570
  * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of
2696
2571
  * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount.
2697
2572
  * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines.
2698
- *
2699
2573
  */
2700
2574
  export type DiscountApplicationTargetSelection =
2701
2575
  /** The discount is allocated onto all the lines. */
@@ -2705,20 +2579,14 @@ export type DiscountApplicationTargetSelection =
2705
2579
  /** The discount is allocated onto explicitly chosen lines. */
2706
2580
  | 'EXPLICIT';
2707
2581
 
2708
- /**
2709
- * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.
2710
- *
2711
- */
2582
+ /** The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. */
2712
2583
  export type DiscountApplicationTargetType =
2713
2584
  /** The discount applies onto line items. */
2714
2585
  | 'LINE_ITEM'
2715
2586
  /** The discount applies onto shipping lines. */
2716
2587
  | 'SHIPPING_LINE';
2717
2588
 
2718
- /**
2719
- * The type of the discount application.
2720
- *
2721
- */
2589
+ /** The type of the discount application. */
2722
2590
  export type DiscountApplicationType =
2723
2591
  /** Automatic discount application type. */
2724
2592
  | 'AUTOMATIC'
@@ -2729,10 +2597,7 @@ export type DiscountApplicationType =
2729
2597
  /** Script discount application type. */
2730
2598
  | 'SCRIPT';
2731
2599
 
2732
- /**
2733
- * Captures the intentions of a discount code at the time that it is applied.
2734
- *
2735
- */
2600
+ /** Captures the intentions of a discount code at the time that it is applied. */
2736
2601
  export type DiscountCodeApplication = DiscountApplication & {
2737
2602
  __typename?: 'DiscountCodeApplication';
2738
2603
  /** The method by which the discount's value is allocated to its entitled items. */
@@ -2768,22 +2633,16 @@ export type Domain = Node & {
2768
2633
  url: Scalars['URL']['output'];
2769
2634
  };
2770
2635
 
2771
- /** A draft order for the customer. Any fields related to money are in the presentment currency. */
2636
+ /** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2772
2637
  export type DraftOrder = Node & {
2773
2638
  __typename?: 'DraftOrder';
2774
- /**
2775
- * The billing address of the customer.
2776
- *
2777
- */
2639
+ /** The billing address of the customer. */
2778
2640
  billingAddress?: Maybe<CustomerAddress>;
2779
2641
  /** Whether the customer who made the draft order has an associated enabled contact. */
2780
2642
  contactExists: Scalars['Boolean']['output'];
2781
2643
  /** The date and time when the draft order was created in Shopify. */
2782
2644
  createdAt: Scalars['DateTime']['output'];
2783
- /**
2784
- * The three-letter code for the currency of the store at the time that the invoice is sent.
2785
- *
2786
- */
2645
+ /** The three-letter code for the currency of the store at the time that the invoice is sent. */
2787
2646
  currencyCode: CurrencyCode;
2788
2647
  /** The customer who placed the order. */
2789
2648
  customer?: Maybe<Customer>;
@@ -2807,10 +2666,7 @@ export type DraftOrder = Node & {
2807
2666
  lineItems: DraftOrderLineItemConnection;
2808
2667
  /** The summary of draft order line items quantity. */
2809
2668
  lineItemsSummary?: Maybe<DraftOrderLineItemsSummary>;
2810
- /**
2811
- * The unique identifier for the draft order, which is unique within the store. For example, _#D1223_.
2812
- *
2813
- */
2669
+ /** The unique identifier for the draft order, which is unique within the store. For example, _#D1223_. */
2814
2670
  name: Scalars['String']['output'];
2815
2671
  /** The order that was created from this draft order. */
2816
2672
  order?: Maybe<Order>;
@@ -2824,15 +2680,9 @@ export type DraftOrder = Node & {
2824
2680
  shippingAddress?: Maybe<CustomerAddress>;
2825
2681
  /** The status of the draft order. */
2826
2682
  status: DraftOrderStatus;
2827
- /**
2828
- * The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes).
2829
- *
2830
- */
2683
+ /** The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes). */
2831
2684
  subtotalPrice: MoneyV2;
2832
- /**
2833
- * The subtotal of the line items (doesn't include shipping charges, taxes, or any discounts).
2834
- *
2835
- */
2685
+ /** The subtotal of the line items (doesn't include shipping charges, taxes, or any discounts). */
2836
2686
  subtotalPriceBeforeDiscounts: MoneyV2;
2837
2687
  /** Indicates whether the draft order is tax exempt. */
2838
2688
  taxExempt: Scalars['Boolean']['output'];
@@ -2840,32 +2690,22 @@ export type DraftOrder = Node & {
2840
2690
  taxesIncluded: Scalars['Boolean']['output'];
2841
2691
  /** The total price of line items for this draft order. */
2842
2692
  totalLineItemsPrice: MoneyV2;
2843
- /**
2844
- * The total amount of the draft order (includes taxes, shipping charges, and discounts).
2845
- *
2846
- */
2693
+ /** The total amount of the draft order (includes taxes, shipping charges, and discounts). */
2847
2694
  totalPrice: MoneyV2;
2848
- /**
2849
- * The total shipping charge for the draft order.
2850
- *
2851
- */
2695
+ /** The total shipping charge for the draft order. */
2852
2696
  totalShippingPrice: MoneyV2;
2853
- /**
2854
- * The total amount of taxes for the draft order.
2855
- *
2856
- */
2697
+ /** The total amount of taxes for the draft order. */
2857
2698
  totalTax: MoneyV2;
2858
2699
  /** The total weight (in grams) of the draft order. */
2859
2700
  totalWeight: Scalars['UnsignedInt64']['output'];
2860
2701
  /**
2861
2702
  * The date and time when the draft order was last changed.
2862
2703
  * The format is YYYY-MM-DD HH:mm:ss (for example, 2016-02-05 17:04:01).
2863
- *
2864
2704
  */
2865
2705
  updatedAt: Scalars['DateTime']['output'];
2866
2706
  };
2867
2707
 
2868
- /** A draft order for the customer. Any fields related to money are in the presentment currency. */
2708
+ /** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
2869
2709
  export type DraftOrderLineItemsArgs = {
2870
2710
  after?: InputMaybe<Scalars['String']['input']>;
2871
2711
  before?: InputMaybe<Scalars['String']['input']>;
@@ -2894,7 +2734,6 @@ export type DraftOrderByCompanySortKeys =
2894
2734
  /**
2895
2735
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
2896
2736
  * Don't use this sort key when no search query is specified.
2897
- *
2898
2737
  */
2899
2738
  | 'RELEVANCE'
2900
2739
  /** Sort by the `status` value. */
@@ -2915,7 +2754,6 @@ export type DraftOrderByLocationSortKeys =
2915
2754
  /**
2916
2755
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
2917
2756
  * Don't use this sort key when no search query is specified.
2918
- *
2919
2757
  */
2920
2758
  | 'RELEVANCE'
2921
2759
  /** Sort by the `status` value. */
@@ -2925,17 +2763,14 @@ export type DraftOrderByLocationSortKeys =
2925
2763
  /** Sort by the `updated_at` value. */
2926
2764
  | 'UPDATED_AT';
2927
2765
 
2928
- /**
2929
- * An auto-generated type for paginating through multiple DraftOrders.
2930
- *
2931
- */
2766
+ /** An auto-generated type for paginating through multiple DraftOrders. */
2932
2767
  export type DraftOrderConnection = {
2933
2768
  __typename?: 'DraftOrderConnection';
2934
- /** A list of edges. */
2769
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
2935
2770
  edges: Array<DraftOrderEdge>;
2936
- /** A list of the nodes contained in DraftOrderEdge. */
2771
+ /** A list of nodes that are contained in DraftOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
2937
2772
  nodes: Array<DraftOrder>;
2938
- /** Information to aid in pagination. */
2773
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
2939
2774
  pageInfo: PageInfo;
2940
2775
  };
2941
2776
 
@@ -2948,13 +2783,10 @@ export type DraftOrderDiscountInformation = {
2948
2783
  totalDiscounts: MoneyV2;
2949
2784
  };
2950
2785
 
2951
- /**
2952
- * An auto-generated type which holds one DraftOrder and a cursor during pagination.
2953
- *
2954
- */
2786
+ /** An auto-generated type which holds one DraftOrder and a cursor during pagination. */
2955
2787
  export type DraftOrderEdge = {
2956
2788
  __typename?: 'DraftOrderEdge';
2957
- /** A cursor for use in pagination. */
2789
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
2958
2790
  cursor: Scalars['String']['output'];
2959
2791
  /** The item at the end of DraftOrderEdge. */
2960
2792
  node: DraftOrder;
@@ -2965,15 +2797,9 @@ export type DraftOrderLineItem = Node & {
2965
2797
  __typename?: 'DraftOrderLineItem';
2966
2798
  /** The discount information for the draft order line item. */
2967
2799
  discountInformation: DraftOrderLineItemDiscountInformation;
2968
- /**
2969
- * The total price of the line item after discounts have been applied.
2970
- *
2971
- */
2800
+ /** The total price of the line item after discounts have been applied. */
2972
2801
  discountedTotal: MoneyV2;
2973
- /**
2974
- * The discounted total divided by the quantity, resulting in the value of the discount per unit.
2975
- *
2976
- */
2802
+ /** The discounted total divided by the quantity, resulting in the value of the discount per unit. */
2977
2803
  discountedUnitPrice: MoneyV2;
2978
2804
  /** A globally-unique ID. */
2979
2805
  id: Scalars['ID']['output'];
@@ -2987,10 +2813,7 @@ export type DraftOrderLineItem = Node & {
2987
2813
  legacyFeeTitle?: Maybe<Scalars['String']['output']>;
2988
2814
  /** The name of the product. */
2989
2815
  name: Scalars['String']['output'];
2990
- /**
2991
- * The total price of the line item, based on the original unit price of the variant multiplied by the quantity. This total doesn't include any discounts.
2992
- *
2993
- */
2816
+ /** The total price of the line item, based on the original unit price of the variant multiplied by the quantity. This total doesn't include any discounts. */
2994
2817
  originalTotal: MoneyV2;
2995
2818
  /** The price of the variant without any discounts applied. */
2996
2819
  originalUnitPrice: MoneyV2;
@@ -3012,25 +2835,14 @@ export type DraftOrderLineItem = Node & {
3012
2835
  weight?: Maybe<Weight>;
3013
2836
  };
3014
2837
 
3015
- /** A line item included in a draft order. */
3016
- export type DraftOrderLineItemImageArgs = {
3017
- crop?: InputMaybe<CropRegion>;
3018
- maxHeight?: InputMaybe<Scalars['Int']['input']>;
3019
- maxWidth?: InputMaybe<Scalars['Int']['input']>;
3020
- scale?: InputMaybe<Scalars['Int']['input']>;
3021
- };
3022
-
3023
- /**
3024
- * An auto-generated type for paginating through multiple DraftOrderLineItems.
3025
- *
3026
- */
2838
+ /** An auto-generated type for paginating through multiple DraftOrderLineItems. */
3027
2839
  export type DraftOrderLineItemConnection = {
3028
2840
  __typename?: 'DraftOrderLineItemConnection';
3029
- /** A list of edges. */
2841
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3030
2842
  edges: Array<DraftOrderLineItemEdge>;
3031
- /** A list of the nodes contained in DraftOrderLineItemEdge. */
2843
+ /** A list of nodes that are contained in DraftOrderLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3032
2844
  nodes: Array<DraftOrderLineItem>;
3033
- /** Information to aid in pagination. */
2845
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3034
2846
  pageInfo: PageInfo;
3035
2847
  };
3036
2848
 
@@ -3043,13 +2855,10 @@ export type DraftOrderLineItemDiscountInformation = {
3043
2855
  totalDiscount: MoneyV2;
3044
2856
  };
3045
2857
 
3046
- /**
3047
- * An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination.
3048
- *
3049
- */
2858
+ /** An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. */
3050
2859
  export type DraftOrderLineItemEdge = {
3051
2860
  __typename?: 'DraftOrderLineItemEdge';
3052
- /** A cursor for use in pagination. */
2861
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3053
2862
  cursor: Scalars['String']['output'];
3054
2863
  /** The item at the end of DraftOrderLineItemEdge. */
3055
2864
  node: DraftOrderLineItem;
@@ -3077,7 +2886,6 @@ export type DraftOrderSortKeys =
3077
2886
  /**
3078
2887
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
3079
2888
  * Don't use this sort key when no search query is specified.
3080
- *
3081
2889
  */
3082
2890
  | 'RELEVANCE'
3083
2891
  /** Sort by the `status` value. */
@@ -3120,40 +2928,19 @@ export type DutySale = Node &
3120
2928
  totalTaxAmount: MoneyV2;
3121
2929
  };
3122
2930
 
3123
- /**
3124
- * Represents the possible email marketing states for a customer.
3125
- *
3126
- */
2931
+ /** Represents the possible email marketing states for a customer. */
3127
2932
  export type EmailMarketingState =
3128
- /**
3129
- * The customer’s email marketing state is invalid.
3130
- *
3131
- */
2933
+ /** The customer’s email marketing state is invalid. */
3132
2934
  | 'INVALID'
3133
- /**
3134
- * The customer isn't subscribed to email marketing.
3135
- *
3136
- */
2935
+ /** The customer isn't subscribed to email marketing. */
3137
2936
  | 'NOT_SUBSCRIBED'
3138
- /**
3139
- * The customer is in the process of subscribing to email marketing.
3140
- *
3141
- */
2937
+ /** The customer is in the process of subscribing to email marketing. */
3142
2938
  | 'PENDING'
3143
- /**
3144
- * The customer's personal data has been erased. This value is internally-set and read-only.
3145
- *
3146
- */
2939
+ /** The customer's personal data has been erased. This value is internally-set and read-only. */
3147
2940
  | 'REDACTED'
3148
- /**
3149
- * The customer is subscribed to email marketing.
3150
- *
3151
- */
2941
+ /** The customer is subscribed to email marketing. */
3152
2942
  | 'SUBSCRIBED'
3153
- /**
3154
- * The customer is not currently subscribed to email marketing but was previously subscribed.
3155
- *
3156
- */
2943
+ /** The customer is not currently subscribed to email marketing but was previously subscribed. */
3157
2944
  | 'UNSUBSCRIBED';
3158
2945
 
3159
2946
  /** Tokens used by ui extensions to query various APIs. */
@@ -3245,27 +3032,21 @@ export type FulfillmentFulfillmentLineItemsArgs = {
3245
3032
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
3246
3033
  };
3247
3034
 
3248
- /**
3249
- * An auto-generated type for paginating through multiple Fulfillments.
3250
- *
3251
- */
3035
+ /** An auto-generated type for paginating through multiple Fulfillments. */
3252
3036
  export type FulfillmentConnection = {
3253
3037
  __typename?: 'FulfillmentConnection';
3254
- /** A list of edges. */
3038
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3255
3039
  edges: Array<FulfillmentEdge>;
3256
- /** A list of the nodes contained in FulfillmentEdge. */
3040
+ /** A list of nodes that are contained in FulfillmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3257
3041
  nodes: Array<Fulfillment>;
3258
- /** Information to aid in pagination. */
3042
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3259
3043
  pageInfo: PageInfo;
3260
3044
  };
3261
3045
 
3262
- /**
3263
- * An auto-generated type which holds one Fulfillment and a cursor during pagination.
3264
- *
3265
- */
3046
+ /** An auto-generated type which holds one Fulfillment and a cursor during pagination. */
3266
3047
  export type FulfillmentEdge = {
3267
3048
  __typename?: 'FulfillmentEdge';
3268
- /** A cursor for use in pagination. */
3049
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3269
3050
  cursor: Scalars['String']['output'];
3270
3051
  /** The item at the end of FulfillmentEdge. */
3271
3052
  node: Fulfillment;
@@ -3274,41 +3055,29 @@ export type FulfillmentEdge = {
3274
3055
  /** An event that occurred for a fulfillment. */
3275
3056
  export type FulfillmentEvent = Node & {
3276
3057
  __typename?: 'FulfillmentEvent';
3277
- /**
3278
- * The time when this fulfillment event occurred.
3279
- *
3280
- */
3058
+ /** The time when this fulfillment event occurred. */
3281
3059
  happenedAt: Scalars['DateTime']['output'];
3282
3060
  /** A globally-unique ID. */
3283
3061
  id: Scalars['ID']['output'];
3284
- /**
3285
- * The status of the fulfillment event.
3286
- *
3287
- */
3062
+ /** The status of the fulfillment event. */
3288
3063
  status: FulfillmentEventStatus;
3289
3064
  };
3290
3065
 
3291
- /**
3292
- * An auto-generated type for paginating through multiple FulfillmentEvents.
3293
- *
3294
- */
3066
+ /** An auto-generated type for paginating through multiple FulfillmentEvents. */
3295
3067
  export type FulfillmentEventConnection = {
3296
3068
  __typename?: 'FulfillmentEventConnection';
3297
- /** A list of edges. */
3069
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3298
3070
  edges: Array<FulfillmentEventEdge>;
3299
- /** A list of the nodes contained in FulfillmentEventEdge. */
3071
+ /** A list of nodes that are contained in FulfillmentEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3300
3072
  nodes: Array<FulfillmentEvent>;
3301
- /** Information to aid in pagination. */
3073
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3302
3074
  pageInfo: PageInfo;
3303
3075
  };
3304
3076
 
3305
- /**
3306
- * An auto-generated type which holds one FulfillmentEvent and a cursor during pagination.
3307
- *
3308
- */
3077
+ /** An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. */
3309
3078
  export type FulfillmentEventEdge = {
3310
3079
  __typename?: 'FulfillmentEventEdge';
3311
- /** A cursor for use in pagination. */
3080
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3312
3081
  cursor: Scalars['String']['output'];
3313
3082
  /** The item at the end of FulfillmentEventEdge. */
3314
3083
  node: FulfillmentEvent;
@@ -3323,74 +3092,34 @@ export type FulfillmentEventSortKeys =
3323
3092
  /**
3324
3093
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
3325
3094
  * Don't use this sort key when no search query is specified.
3326
- *
3327
3095
  */
3328
3096
  | 'RELEVANCE';
3329
3097
 
3330
- /**
3331
- * The status of a fulfillment event.
3332
- *
3333
- */
3098
+ /** The status of a fulfillment event. */
3334
3099
  export type FulfillmentEventStatus =
3335
- /**
3336
- * A delivery was attempted.
3337
- *
3338
- */
3100
+ /** A delivery was attempted. */
3339
3101
  | 'ATTEMPTED_DELIVERY'
3340
- /**
3341
- * The fulfillment has been picked up by the carrier.
3342
- *
3343
- */
3102
+ /** The fulfillment has been picked up by the carrier. */
3344
3103
  | 'CARRIER_PICKED_UP'
3345
- /**
3346
- * The fulfillment is confirmed.
3347
- *
3348
- */
3104
+ /** The fulfillment is confirmed. */
3349
3105
  | 'CONFIRMED'
3350
- /**
3351
- * The fulfillment is delayed.
3352
- *
3353
- */
3106
+ /** The fulfillment is delayed. */
3354
3107
  | 'DELAYED'
3355
- /**
3356
- * The fulfillment was successfully delivered.
3357
- *
3358
- */
3108
+ /** The fulfillment was successfully delivered. */
3359
3109
  | 'DELIVERED'
3360
- /**
3361
- * The fulfillment request failed.
3362
- *
3363
- */
3110
+ /** The fulfillment request failed. */
3364
3111
  | 'FAILURE'
3365
- /**
3366
- * The fulfillment is in transit.
3367
- *
3368
- */
3112
+ /** The fulfillment is in transit. */
3369
3113
  | 'IN_TRANSIT'
3370
- /**
3371
- * A purchased shipping label has been printed.
3372
- *
3373
- */
3114
+ /** A purchased shipping label has been printed. */
3374
3115
  | 'LABEL_PRINTED'
3375
- /**
3376
- * A shipping label has been purchased.
3377
- *
3378
- */
3116
+ /** A shipping label has been purchased. */
3379
3117
  | 'LABEL_PURCHASED'
3380
- /**
3381
- * The fulfillment is out for delivery.
3382
- *
3383
- */
3118
+ /** The fulfillment is out for delivery. */
3384
3119
  | 'OUT_FOR_DELIVERY'
3385
- /**
3386
- * The fulfillment was successfully picked up.
3387
- *
3388
- */
3120
+ /** The fulfillment was successfully picked up. */
3389
3121
  | 'PICKED_UP'
3390
- /**
3391
- * The fulfillment is ready to be picked up.
3392
- *
3393
- */
3122
+ /** The fulfillment is ready to be picked up. */
3394
3123
  | 'READY_FOR_PICKUP';
3395
3124
 
3396
3125
  /** Represents a line item from an order that's included in a fulfillment. */
@@ -3404,27 +3133,21 @@ export type FulfillmentLineItem = Node & {
3404
3133
  quantity?: Maybe<Scalars['Int']['output']>;
3405
3134
  };
3406
3135
 
3407
- /**
3408
- * An auto-generated type for paginating through multiple FulfillmentLineItems.
3409
- *
3410
- */
3136
+ /** An auto-generated type for paginating through multiple FulfillmentLineItems. */
3411
3137
  export type FulfillmentLineItemConnection = {
3412
3138
  __typename?: 'FulfillmentLineItemConnection';
3413
- /** A list of edges. */
3139
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3414
3140
  edges: Array<FulfillmentLineItemEdge>;
3415
- /** A list of the nodes contained in FulfillmentLineItemEdge. */
3141
+ /** A list of nodes that are contained in FulfillmentLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3416
3142
  nodes: Array<FulfillmentLineItem>;
3417
- /** Information to aid in pagination. */
3143
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3418
3144
  pageInfo: PageInfo;
3419
3145
  };
3420
3146
 
3421
- /**
3422
- * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination.
3423
- *
3424
- */
3147
+ /** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */
3425
3148
  export type FulfillmentLineItemEdge = {
3426
3149
  __typename?: 'FulfillmentLineItemEdge';
3427
- /** A cursor for use in pagination. */
3150
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3428
3151
  cursor: Scalars['String']['output'];
3429
3152
  /** The item at the end of FulfillmentLineItemEdge. */
3430
3153
  node: FulfillmentLineItem;
@@ -3439,7 +3162,6 @@ export type FulfillmentSortKeys =
3439
3162
  /**
3440
3163
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
3441
3164
  * Don't use this sort key when no search query is specified.
3442
- *
3443
3165
  */
3444
3166
  | 'RELEVANCE';
3445
3167
 
@@ -3451,15 +3173,9 @@ export type FulfillmentStatus =
3451
3173
  | 'ERROR'
3452
3174
  /** The fulfillment request failed. */
3453
3175
  | 'FAILURE'
3454
- /**
3455
- * The third-party fulfillment service has acknowledged the fulfillment and is processing it.
3456
- *
3457
- */
3176
+ /** The third-party fulfillment service has acknowledged the fulfillment and is processing it. */
3458
3177
  | 'OPEN'
3459
- /**
3460
- * Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`.
3461
- *
3462
- */
3178
+ /** Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`. */
3463
3179
  | 'PENDING'
3464
3180
  /** The fulfillment was completed successfully. */
3465
3181
  | 'SUCCESS';
@@ -3568,7 +3284,6 @@ export type GooglePayWalletConfig = {
3568
3284
  * Represents a summary of the current version of data in a resource.
3569
3285
  *
3570
3286
  * The `compare_digest` field can be used as input for mutations that implement a compare-and-swap mechanism.
3571
- *
3572
3287
  */
3573
3288
  export type HasCompareDigest = {
3574
3289
  /** The data stored in the resource, represented as a digest. */
@@ -3582,7 +3297,6 @@ export type HasMetafields = {
3582
3297
  /**
3583
3298
  * The metafields associated with the resource matching the
3584
3299
  * supplied list of namespaces and keys.
3585
- *
3586
3300
  */
3587
3301
  metafields: Array<Maybe<Metafield>>;
3588
3302
  };
@@ -3634,7 +3348,6 @@ export type Image = {
3634
3348
  * The location of the original image as a URL.
3635
3349
  *
3636
3350
  * If there are any existing transformations in the original source URL, they will remain and not be stripped.
3637
- *
3638
3351
  * @deprecated Use `url` instead.
3639
3352
  */
3640
3353
  originalSrc: Scalars['URL']['output'];
@@ -3648,7 +3361,6 @@ export type Image = {
3648
3361
  *
3649
3362
  * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be.
3650
3363
  * Otherwise any transformations which an image type doesn't support will be ignored.
3651
- *
3652
3364
  * @deprecated Use `url(transform:)` instead
3653
3365
  */
3654
3366
  transformedSrc: Scalars['URL']['output'];
@@ -3660,7 +3372,6 @@ export type Image = {
3660
3372
  * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.
3661
3373
  *
3662
3374
  * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).
3663
- *
3664
3375
  */
3665
3376
  url: Scalars['URL']['output'];
3666
3377
  /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */
@@ -3694,7 +3405,6 @@ export type ImageContentType =
3694
3405
  * The available options for transforming an image.
3695
3406
  *
3696
3407
  * All transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored.
3697
- *
3698
3408
  */
3699
3409
  export type ImageTransformInput = {
3700
3410
  /**
@@ -3703,61 +3413,38 @@ export type ImageTransformInput = {
3703
3413
  * The `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while
3704
3414
  * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result
3705
3415
  * in an image with a width of 5 and height of 10, where the right side of the image is removed.
3706
- *
3707
3416
  */
3708
3417
  crop?: InputMaybe<CropRegion>;
3709
- /**
3710
- * Image height in pixels between 1 and 5760.
3711
- *
3712
- */
3418
+ /** Image height in pixels between 1 and 5760. */
3713
3419
  maxHeight?: InputMaybe<Scalars['Int']['input']>;
3714
- /**
3715
- * Image width in pixels between 1 and 5760.
3716
- *
3717
- */
3420
+ /** Image width in pixels between 1 and 5760. */
3718
3421
  maxWidth?: InputMaybe<Scalars['Int']['input']>;
3719
3422
  /**
3720
3423
  * Convert the source image into the preferred content type.
3721
3424
  * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`.
3722
- *
3723
3425
  */
3724
3426
  preferredContentType?: InputMaybe<ImageContentType>;
3725
- /**
3726
- * Image size multiplier for high-resolution retina displays. Must be within 1..3.
3727
- *
3728
- */
3427
+ /** Image size multiplier for high-resolution retina displays. Must be within 1..3. */
3729
3428
  scale?: InputMaybe<Scalars['Int']['input']>;
3730
3429
  };
3731
3430
 
3732
3431
  /** An object representing a product marked as a fee, aggregated by title. */
3733
3432
  export type LegacyAggregatedMerchandiseTermsAsFees = Node & {
3734
3433
  __typename?: 'LegacyAggregatedMerchandiseTermsAsFees';
3735
- /**
3736
- * The description of the fee line, as provided by the _legacy_product_as_fee_description line item property.
3737
- *
3738
- */
3434
+ /** The description of the fee line, as provided by the _legacy_product_as_fee_description line item property. */
3739
3435
  description?: Maybe<Scalars['String']['output']>;
3740
3436
  /** A globally-unique ID. */
3741
3437
  id: Scalars['ID']['output'];
3742
- /**
3743
- * The title of the fee line, as provided by the _legacy_product_as_fee_title line item property.
3744
- *
3745
- */
3438
+ /** The title of the fee line, as provided by the _legacy_product_as_fee_title line item property. */
3746
3439
  title: Scalars['String']['output'];
3747
- /**
3748
- * The total value of all the products with the same title.
3749
- *
3750
- */
3440
+ /** The total value of all the products with the same title. */
3751
3441
  total: MoneyV2;
3752
3442
  };
3753
3443
 
3754
3444
  /** A single line item in an order. */
3755
3445
  export type LineItem = Node & {
3756
3446
  __typename?: 'LineItem';
3757
- /**
3758
- * The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.
3759
- *
3760
- */
3447
+ /** The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies. */
3761
3448
  currentTotalPrice?: Maybe<MoneyV2>;
3762
3449
  /** The list of custom attributes associated with the line item. */
3763
3450
  customAttributes: Array<Attribute>;
@@ -3811,25 +3498,13 @@ export type LineItem = Node & {
3811
3498
  supportedReturnReasons: Array<ReturnSupportedReason>;
3812
3499
  /** The title of the product or variant. This field only applies to custom line items. */
3813
3500
  title: Scalars['String']['output'];
3814
- /**
3815
- * The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item.
3816
- *
3817
- */
3501
+ /** The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item. */
3818
3502
  totalDiscount: MoneyV2;
3819
- /**
3820
- * The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.
3821
- *
3822
- */
3503
+ /** The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies. */
3823
3504
  totalPrice?: Maybe<MoneyV2>;
3824
- /**
3825
- * The total price of the line item, calculated by multiplying the unit price of the variant (before any discounts) by the quantity, expressed in presentment currencies.
3826
- *
3827
- */
3505
+ /** The total price of the line item, calculated by multiplying the unit price of the variant (before any discounts) by the quantity, expressed in presentment currencies. */
3828
3506
  totalPriceBeforeDiscounts?: Maybe<MoneyV2>;
3829
- /**
3830
- * The total price of the line item, calculated by multiplying the unit price of the variant (after line item discounts) by the quantity, expressed in presentment currencies.
3831
- *
3832
- */
3507
+ /** The total price of the line item, calculated by multiplying the unit price of the variant (after line item discounts) by the quantity, expressed in presentment currencies. */
3833
3508
  totalPriceWithDiscounts?: Maybe<MoneyV2>;
3834
3509
  /** The unit price of the line item in presentment currencies. */
3835
3510
  unitPrice?: Maybe<UnitPrice>;
@@ -3843,24 +3518,18 @@ export type LineItem = Node & {
3843
3518
  vendor?: Maybe<Scalars['String']['output']>;
3844
3519
  };
3845
3520
 
3846
- /**
3847
- * An auto-generated type for paginating through multiple LineItems.
3848
- *
3849
- */
3521
+ /** An auto-generated type for paginating through multiple LineItems. */
3850
3522
  export type LineItemConnection = {
3851
3523
  __typename?: 'LineItemConnection';
3852
- /** A list of edges. */
3524
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3853
3525
  edges: Array<LineItemEdge>;
3854
- /** A list of the nodes contained in LineItemEdge. */
3526
+ /** A list of nodes that are contained in LineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3855
3527
  nodes: Array<LineItem>;
3856
- /** Information to aid in pagination. */
3528
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3857
3529
  pageInfo: PageInfo;
3858
3530
  };
3859
3531
 
3860
- /**
3861
- * The information about the line item category for the order.
3862
- *
3863
- */
3532
+ /** The information about the line item category for the order. */
3864
3533
  export type LineItemContainer =
3865
3534
  | RemainingLineItemContainer
3866
3535
  | UnfulfilledDigitalLineItemContainer
@@ -3868,10 +3537,7 @@ export type LineItemContainer =
3868
3537
  | UnfulfilledLineItemContainer
3869
3538
  | UnfulfilledPhysicalLineItemContainer;
3870
3539
 
3871
- /**
3872
- * The information about the line item in the line item container.
3873
- *
3874
- */
3540
+ /** The information about the line item in the line item container. */
3875
3541
  export type LineItemContainerLineItem = Node & {
3876
3542
  __typename?: 'LineItemContainerLineItem';
3877
3543
  /** A globally-unique ID. */
@@ -3884,27 +3550,21 @@ export type LineItemContainerLineItem = Node & {
3884
3550
  totalQuantity: Scalars['Int']['output'];
3885
3551
  };
3886
3552
 
3887
- /**
3888
- * An auto-generated type for paginating through multiple LineItemContainerLineItems.
3889
- *
3890
- */
3553
+ /** An auto-generated type for paginating through multiple LineItemContainerLineItems. */
3891
3554
  export type LineItemContainerLineItemConnection = {
3892
3555
  __typename?: 'LineItemContainerLineItemConnection';
3893
- /** A list of edges. */
3556
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
3894
3557
  edges: Array<LineItemContainerLineItemEdge>;
3895
- /** A list of the nodes contained in LineItemContainerLineItemEdge. */
3558
+ /** A list of nodes that are contained in LineItemContainerLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
3896
3559
  nodes: Array<LineItemContainerLineItem>;
3897
- /** Information to aid in pagination. */
3560
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
3898
3561
  pageInfo: PageInfo;
3899
3562
  };
3900
3563
 
3901
- /**
3902
- * An auto-generated type which holds one LineItemContainerLineItem and a cursor during pagination.
3903
- *
3904
- */
3564
+ /** An auto-generated type which holds one LineItemContainerLineItem and a cursor during pagination. */
3905
3565
  export type LineItemContainerLineItemEdge = {
3906
3566
  __typename?: 'LineItemContainerLineItemEdge';
3907
- /** A cursor for use in pagination. */
3567
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3908
3568
  cursor: Scalars['String']['output'];
3909
3569
  /** The item at the end of LineItemContainerLineItemEdge. */
3910
3570
  node: LineItemContainerLineItem;
@@ -3919,13 +3579,10 @@ export type LineItemDiscountInformation = {
3919
3579
  title?: Maybe<Scalars['String']['output']>;
3920
3580
  };
3921
3581
 
3922
- /**
3923
- * An auto-generated type which holds one LineItem and a cursor during pagination.
3924
- *
3925
- */
3582
+ /** An auto-generated type which holds one LineItem and a cursor during pagination. */
3926
3583
  export type LineItemEdge = {
3927
3584
  __typename?: 'LineItemEdge';
3928
- /** A cursor for use in pagination. */
3585
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
3929
3586
  cursor: Scalars['String']['output'];
3930
3587
  /** The item at the end of LineItemEdge. */
3931
3588
  node: LineItem;
@@ -3934,15 +3591,9 @@ export type LineItemEdge = {
3934
3591
  /** The selling plan for a line item. */
3935
3592
  export type LineItemSellingPlan = {
3936
3593
  __typename?: 'LineItemSellingPlan';
3937
- /**
3938
- * The name of the selling plan for display purposes.
3939
- *
3940
- */
3594
+ /** The name of the selling plan for display purposes. */
3941
3595
  name: Scalars['String']['output'];
3942
- /**
3943
- * The ID of the selling plan associated with the line item.
3944
- *
3945
- */
3596
+ /** The ID of the selling plan associated with the line item. */
3946
3597
  sellingPlanId?: Maybe<Scalars['ID']['output']>;
3947
3598
  };
3948
3599
 
@@ -3955,10 +3606,7 @@ export type LineItemVariantOption = {
3955
3606
  value: Scalars['String']['output'];
3956
3607
  };
3957
3608
 
3958
- /**
3959
- * Captures the intentions of a discount that was manually created.
3960
- *
3961
- */
3609
+ /** Captures the intentions of a discount that was manually created. */
3962
3610
  export type ManualDiscountApplication = DiscountApplication & {
3963
3611
  __typename?: 'ManualDiscountApplication';
3964
3612
  /** The method by which the discount's value is allocated to its entitled items. */
@@ -3978,7 +3626,6 @@ export type ManualDiscountApplication = DiscountApplication & {
3978
3626
  /**
3979
3627
  * A market, which is a group of one or more regions targeted for international sales.
3980
3628
  * A market allows configuration of a distinct, localized shopping experience for customers from a specific area of the world.
3981
- *
3982
3629
  */
3983
3630
  export type Market = Node & {
3984
3631
  __typename?: 'Market';
@@ -3992,7 +3639,6 @@ export type Market = Node & {
3992
3639
  * language variants. If a market doesn't have its own web presence, then the market is accessible on the
3993
3640
  * shop’s primary domain using [country
3994
3641
  * selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).
3995
- *
3996
3642
  */
3997
3643
  webPresence?: Maybe<MarketWebPresence>;
3998
3644
  };
@@ -4010,31 +3656,23 @@ export type Market = Node & {
4010
3656
  * here do govern [the languages available on the Storefront
4011
3657
  * API](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in
4012
3658
  * this market.
4013
- *
4014
3659
  */
4015
3660
  export type MarketWebPresence = Node & {
4016
3661
  __typename?: 'MarketWebPresence';
4017
3662
  /**
4018
3663
  * The domain of the web presence.
4019
3664
  * This field will be null if `subfolderSuffix` isn't null.
4020
- *
4021
3665
  */
4022
3666
  domain?: Maybe<Domain>;
4023
3667
  /** A globally-unique identifier. */
4024
3668
  id: Scalars['ID']['output'];
4025
- /**
4026
- * The list of root URLs for each of the web presence’s locales.
4027
- *
4028
- */
3669
+ /** The list of root URLs for each of the web presence’s locales. */
4029
3670
  rootUrls: Array<MarketWebPresenceRootUrl>;
4030
3671
  /** The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null. */
4031
3672
  subfolderSuffix?: Maybe<Scalars['String']['output']>;
4032
3673
  };
4033
3674
 
4034
- /**
4035
- * The URL for the homepage of the online store in the context of a particular market and a particular locale.
4036
- *
4037
- */
3675
+ /** The URL for the homepage of the online store in the context of a particular market and a particular locale. */
4038
3676
  export type MarketWebPresenceRootUrl = {
4039
3677
  __typename?: 'MarketWebPresenceRootUrl';
4040
3678
  /** The locale in which the storefront loads. */
@@ -4046,7 +3684,6 @@ export type MarketWebPresenceRootUrl = {
4046
3684
  /**
4047
3685
  * The custom metadata attached to a resource. Metafields can be sorted into namespaces and are
4048
3686
  * comprised of keys, values, and value types.
4049
- *
4050
3687
  */
4051
3688
  export type Metafield = HasCompareDigest &
4052
3689
  Node & {
@@ -4068,7 +3705,6 @@ export type Metafield = HasCompareDigest &
4068
3705
  /**
4069
3706
  * The type name of the metafield.
4070
3707
  * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).
4071
- *
4072
3708
  */
4073
3709
  type: Scalars['String']['output'];
4074
3710
  /** The date and time when the metafield was updated. */
@@ -4077,10 +3713,7 @@ export type Metafield = HasCompareDigest &
4077
3713
  value: Scalars['String']['output'];
4078
3714
  };
4079
3715
 
4080
- /**
4081
- * Identifies a metafield by its owner resource, namespace, and key.
4082
- *
4083
- */
3716
+ /** Identifies a metafield by its owner resource, namespace, and key. */
4084
3717
  export type MetafieldIdentifier = {
4085
3718
  __typename?: 'MetafieldIdentifier';
4086
3719
  /** The key of the metafield. */
@@ -4091,10 +3724,7 @@ export type MetafieldIdentifier = {
4091
3724
  ownerId: Scalars['ID']['output'];
4092
3725
  };
4093
3726
 
4094
- /**
4095
- * The input fields that identify metafields.
4096
- *
4097
- */
3727
+ /** The input fields that identify metafields. */
4098
3728
  export type MetafieldIdentifierInput = {
4099
3729
  /** The key of the metafield. */
4100
3730
  key: Scalars['String']['input'];
@@ -4154,15 +3784,11 @@ export type MetafieldsDeleteUserErrorCode =
4154
3784
 
4155
3785
  /** The input fields for a metafield value to set. */
4156
3786
  export type MetafieldsSetInput = {
4157
- /**
4158
- * The `compareDigest` value obtained from a previous query. Provide this with updates to ensure the metafield is modified safely.
4159
- *
4160
- */
3787
+ /** The `compareDigest` value obtained from a previous query. Provide this with updates to ensure the metafield is modified safely. */
4161
3788
  compareDigest?: InputMaybe<Scalars['String']['input']>;
4162
3789
  /**
4163
3790
  * The unique identifier for a metafield within its namespace.
4164
3791
  * Must be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters.
4165
- *
4166
3792
  */
4167
3793
  key: Scalars['String']['input'];
4168
3794
  /**
@@ -4170,7 +3796,6 @@ export type MetafieldsSetInput = {
4170
3796
  * with `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the
4171
3797
  * same `key`.
4172
3798
  * Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.
4173
- *
4174
3799
  */
4175
3800
  namespace: Scalars['String']['input'];
4176
3801
  /** The unique ID of the resource that the metafield is attached to. */
@@ -4180,13 +3805,9 @@ export type MetafieldsSetInput = {
4180
3805
  * The type must be one of the [supported types](https://shopify.dev/apps/metafields/types).
4181
3806
  * Required when there is no corresponding definition for the given `namespace`, `key`, and
4182
3807
  * owner resource type (derived from `ownerId`).
4183
- *
4184
3808
  */
4185
3809
  type?: InputMaybe<Scalars['String']['input']>;
4186
- /**
4187
- * The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
4188
- *
4189
- */
3810
+ /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */
4190
3811
  value: Scalars['String']['input'];
4191
3812
  };
4192
3813
 
@@ -4242,7 +3863,6 @@ export type MetafieldsSetUserErrorCode =
4242
3863
  /**
4243
3864
  * A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions,
4244
3865
  * when an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency).
4245
- *
4246
3866
  */
4247
3867
  export type MoneyBag = {
4248
3868
  __typename?: 'MoneyBag';
@@ -4252,10 +3872,7 @@ export type MoneyBag = {
4252
3872
  shopMoney: MoneyV2;
4253
3873
  };
4254
3874
 
4255
- /**
4256
- * A monetary value with currency.
4257
- *
4258
- */
3875
+ /** A monetary value with currency. */
4259
3876
  export type MoneyV2 = {
4260
3877
  __typename?: 'MoneyV2';
4261
3878
  /** Decimal money amount. */
@@ -4273,25 +3890,13 @@ export type Mutation = {
4273
3890
  applePayCreditCardUpdate?: Maybe<ApplePayCreditCardUpdatePayload>;
4274
3891
  /** Creates a new Apple Pay session. */
4275
3892
  applePaySessionCreate?: Maybe<ApplePaySessionCreatePayload>;
4276
- /**
4277
- * Updates the information for a business contact.
4278
- *
4279
- */
3893
+ /** Updates the information for a business contact. */
4280
3894
  businessContactUpdate?: Maybe<BusinessContactUpdatePayload>;
4281
- /**
4282
- * Adds a new credit card to the available payment methods of a customer.
4283
- *
4284
- */
3895
+ /** Adds a new credit card to the available payment methods of a customer. */
4285
3896
  businessLocationCreditCardAdd?: Maybe<BusinessLocationCreditCardAddPayload>;
4286
- /**
4287
- * Updates the details of a credit card for a customer.
4288
- *
4289
- */
3897
+ /** Updates the details of a credit card for a customer. */
4290
3898
  businessLocationCreditCardUpdate?: Maybe<BusinessLocationCreditCardUpdatePayload>;
4291
- /**
4292
- * Removes a payment instrument from a customer.
4293
- *
4294
- */
3899
+ /** Removes a payment instrument from a customer. */
4295
3900
  businessLocationPaymentInstrumentRemove?: Maybe<BusinessLocationPaymentInstrumentRemovePayload>;
4296
3901
  /** Updates an address on a company location. */
4297
3902
  companyLocationAssignAddress?: Maybe<CompanyLocationAssignAddressPayload>;
@@ -4299,20 +3904,11 @@ export type Mutation = {
4299
3904
  creditCardAdd?: Maybe<CreditCardAddPayload>;
4300
3905
  /** Updates the details of a customer's credit card. */
4301
3906
  creditCardUpdate?: Maybe<CreditCardUpdatePayload>;
4302
- /**
4303
- * Creates a new address for a customer.
4304
- *
4305
- */
3907
+ /** Creates a new address for a customer. */
4306
3908
  customerAddressCreate?: Maybe<CustomerAddressCreatePayload>;
4307
- /**
4308
- * Deletes a specific address for a customer.
4309
- *
4310
- */
3909
+ /** Deletes a specific address for a customer. */
4311
3910
  customerAddressDelete?: Maybe<CustomerAddressDeletePayload>;
4312
- /**
4313
- * Updates a specific address for a customer.
4314
- *
4315
- */
3911
+ /** Updates a specific address for a customer. */
4316
3912
  customerAddressUpdate?: Maybe<CustomerAddressUpdatePayload>;
4317
3913
  /** Subscribes the customer's email to marketing. */
4318
3914
  customerEmailMarketingOptIn?: Maybe<CustomerEmailMarketingOptInPayload>;
@@ -4320,10 +3916,7 @@ export type Mutation = {
4320
3916
  customerEmailMarketingSubscribe?: Maybe<CustomerEmailMarketingSubscribePayload>;
4321
3917
  /** Unsubscribes the customer from email marketing. */
4322
3918
  customerEmailMarketingUnsubscribe?: Maybe<CustomerEmailMarketingUnsubscribePayload>;
4323
- /**
4324
- * Updates the customer's personal information.
4325
- *
4326
- */
3919
+ /** Updates the customer's personal information. */
4327
3920
  customerUpdate?: Maybe<CustomerUpdatePayload>;
4328
3921
  /** Adds a new credit card by using Google Pay. */
4329
3922
  googlePayCreditCardAdd?: Maybe<GooglePayCreditCardAddPayload>;
@@ -4338,23 +3931,19 @@ export type Mutation = {
4338
3931
  *
4339
3932
  * This operation is atomic, meaning no changes are persisted if an error is encountered.
4340
3933
  *
4341
- * As of `2024-07`, this operation supports compare-and-set functionality to better handle concurrent requests.
3934
+ * As of `2024-10`, this operation supports compare-and-set functionality to better handle concurrent requests.
4342
3935
  * If `compareDigest` is set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on `compareDigest`.
4343
3936
  * If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, set `compareDigest` to `null`.
4344
3937
  * The `compareDigest` value can be acquired by querying the metafield object and selecting `compareDigest` as a field.
4345
3938
  * If the `compareDigest` value does not match the digest for the persisted value, the mutation will return an error.
4346
3939
  * You can opt out of write guarantees by not sending `compareDigest` in the request.
4347
- *
4348
3940
  */
4349
3941
  metafieldsSet?: Maybe<MetafieldsSetPayload>;
4350
3942
  /** Request a new return on behalf of a customer. */
4351
3943
  orderRequestReturn?: Maybe<OrderRequestReturnPayload>;
4352
3944
  /** Removes a payment instrument from a customer's account. */
4353
3945
  paymentInstrumentRemove?: Maybe<PaymentInstrumentRemovePayload>;
4354
- /**
4355
- * Updates a customer's default payment instrument.
4356
- *
4357
- */
3946
+ /** Updates a customer's default payment instrument. */
4358
3947
  paymentInstrumentUpdateDefault?: Maybe<PaymentInstrumentUpdateDefaultPayload>;
4359
3948
  /** Connects a customer's PayPal account for use as a payment method. */
4360
3949
  paypalAccountEnable?: Maybe<PaypalAccountEnablePayload>;
@@ -4367,7 +3956,6 @@ export type Mutation = {
4367
3956
  /**
4368
3957
  * Exchanges the Customer Access Token, provided in the Authorization header, into a Storefront Customer Access Token.
4369
3958
  * Renew this token each time you update the Customer Access Token found in the Authorization header.
4370
- *
4371
3959
  */
4372
3960
  storefrontCustomerAccessTokenCreate?: Maybe<StorefrontCustomerAccessTokenCreatePayload>;
4373
3961
  /** Skips a Subscription Billing Cycle. */
@@ -4566,6 +4154,7 @@ export type MutationSubscriptionContractChangePaymentInstrumentArgs = {
4566
4154
 
4567
4155
  /** This is the schema's entry point for all mutation operations. */
4568
4156
  export type MutationSubscriptionContractFetchDeliveryOptionsArgs = {
4157
+ address?: InputMaybe<CustomerAddressInput>;
4569
4158
  deliveryAddress?: InputMaybe<CustomerMailingAddressInput>;
4570
4159
  subscriptionContractId: Scalars['ID']['input'];
4571
4160
  };
@@ -4587,30 +4176,25 @@ export type MutationSubscriptionContractSelectDeliveryMethodArgs = {
4587
4176
  * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).
4588
4177
  * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)
4589
4178
  * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.
4590
- *
4591
4179
  */
4592
4180
  export type Node = {
4593
4181
  /** A globally-unique ID. */
4594
4182
  id: Scalars['ID']['output'];
4595
4183
  };
4596
4184
 
4597
- /** A customer’s completed request to purchase one or more products from a shop. */
4185
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4598
4186
  export type Order = HasMetafields &
4599
4187
  Node & {
4600
4188
  __typename?: 'Order';
4601
4189
  /** A list of sales agreements associated with the order. */
4602
4190
  agreements: SalesAgreementConnection;
4603
- /**
4604
- * The mailing address provided by the customer. Not all orders have a mailing address.
4605
- *
4606
- */
4191
+ /** The mailing address provided by the customer. Not all orders have a mailing address. */
4607
4192
  billingAddress?: Maybe<CustomerAddress>;
4608
4193
  /** The reason for the cancellation of the order. Returns `null` if the order wasn't canceled. */
4609
4194
  cancelReason?: Maybe<OrderCancelReason>;
4610
4195
  /**
4611
4196
  * The date and time when the order was canceled.
4612
4197
  * Returns `null` if the order wasn't canceled.
4613
- *
4614
4198
  */
4615
4199
  cancelledAt?: Maybe<Scalars['DateTime']['output']>;
4616
4200
  /** The checkout token associated with this order. */
@@ -4619,7 +4203,6 @@ export type Order = HasMetafields &
4619
4203
  * A randomly generated alpha-numeric identifier for the order that may be shown to the customer
4620
4204
  * instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ".
4621
4205
  * This value isn't guaranteed to be unique.
4622
- *
4623
4206
  */
4624
4207
  confirmationNumber?: Maybe<Scalars['String']['output']>;
4625
4208
  /** The date and time when the order was created. */
@@ -4640,10 +4223,7 @@ export type Order = HasMetafields &
4640
4223
  draftOrder?: Maybe<DraftOrder>;
4641
4224
  /** The name of the associated draft order. */
4642
4225
  draftOrderName?: Maybe<Scalars['String']['output']>;
4643
- /**
4644
- * The edit summary of the order.
4645
- *
4646
- */
4226
+ /** The edit summary of the order. */
4647
4227
  editSummary?: Maybe<OrderEditSummary>;
4648
4228
  /** Whether the order has been edited or not. */
4649
4229
  edited: Scalars['Boolean']['output'];
@@ -4684,13 +4264,11 @@ export type Order = HasMetafields &
4684
4264
  /**
4685
4265
  * The metafields associated with the resource matching the
4686
4266
  * supplied list of namespaces and keys.
4687
- *
4688
4267
  */
4689
4268
  metafields: Array<Maybe<Metafield>>;
4690
4269
  /**
4691
4270
  * The identifier for the order that appears on the order.
4692
4271
  * For example, _#1000_ or _Store1001.
4693
- *
4694
4272
  */
4695
4273
  name: Scalars['String']['output'];
4696
4274
  /** The order's notes. */
@@ -4701,10 +4279,7 @@ export type Order = HasMetafields &
4701
4279
  orderReceiptMetafields: Array<Metafield>;
4702
4280
  /** The payment information for the order. */
4703
4281
  paymentInformation?: Maybe<OrderPaymentInformation>;
4704
- /**
4705
- * Represents the merchant configured payment terms.
4706
- *
4707
- */
4282
+ /** Represents the merchant configured payment terms. */
4708
4283
  paymentTermsTemplate?: Maybe<PaymentTermsTemplate>;
4709
4284
  /** The phone number of the customer for SMS notifications. */
4710
4285
  phone?: Maybe<Scalars['String']['output']>;
@@ -4716,7 +4291,6 @@ export type Order = HasMetafields &
4716
4291
  * The date and time when the order was processed.
4717
4292
  * This value can be set to dates in the past when importing from other systems.
4718
4293
  * If no value is provided, it will be auto-generated based on current date and time.
4719
- *
4720
4294
  */
4721
4295
  processedAt: Scalars['DateTime']['output'];
4722
4296
  /** The purchasing entity for the order. */
@@ -4731,15 +4305,9 @@ export type Order = HasMetafields &
4731
4305
  return?: Maybe<Return>;
4732
4306
  /** The list of returns for the order with pagination. */
4733
4307
  returns: ReturnConnection;
4734
- /**
4735
- * The mailing address to which the order items are shipped.
4736
- *
4737
- */
4308
+ /** The mailing address to which the order items are shipped. */
4738
4309
  shippingAddress?: Maybe<CustomerAddress>;
4739
- /**
4740
- * The discounts that have been allocated onto the shipping line by discount applications.
4741
- *
4742
- */
4310
+ /** The discounts that have been allocated onto the shipping line by discount applications. */
4743
4311
  shippingDiscountAllocations: Array<DiscountAllocation>;
4744
4312
  /** A summary of all shipping costs on the order. */
4745
4313
  shippingLine?: Maybe<ShippingLine>;
@@ -4757,6 +4325,8 @@ export type Order = HasMetafields &
4757
4325
  subtotal?: Maybe<MoneyV2>;
4758
4326
  /** The price of the order before order-level discounts, duties, shipping. It includes taxes in tax-inclusive orders. */
4759
4327
  subtotalBeforeDiscounts?: Maybe<MoneyV2>;
4328
+ /** A list of tax invoices associated with the order. */
4329
+ taxInvoices: Array<TaxInvoice>;
4760
4330
  /** The total cost of shipping after discounts. */
4761
4331
  totalDiscountedShipping: MoneyV2;
4762
4332
  /** The total amount of duties after returns. */
@@ -4777,7 +4347,7 @@ export type Order = HasMetafields &
4777
4347
  transactions: Array<OrderTransaction>;
4778
4348
  };
4779
4349
 
4780
- /** A customer’s completed request to purchase one or more products from a shop. */
4350
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4781
4351
  export type OrderAgreementsArgs = {
4782
4352
  after?: InputMaybe<Scalars['String']['input']>;
4783
4353
  before?: InputMaybe<Scalars['String']['input']>;
@@ -4786,7 +4356,7 @@ export type OrderAgreementsArgs = {
4786
4356
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
4787
4357
  };
4788
4358
 
4789
- /** A customer’s completed request to purchase one or more products from a shop. */
4359
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4790
4360
  export type OrderDiscountApplicationsArgs = {
4791
4361
  after?: InputMaybe<Scalars['String']['input']>;
4792
4362
  before?: InputMaybe<Scalars['String']['input']>;
@@ -4795,7 +4365,7 @@ export type OrderDiscountApplicationsArgs = {
4795
4365
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
4796
4366
  };
4797
4367
 
4798
- /** A customer’s completed request to purchase one or more products from a shop. */
4368
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4799
4369
  export type OrderFulfillmentsArgs = {
4800
4370
  after?: InputMaybe<Scalars['String']['input']>;
4801
4371
  before?: InputMaybe<Scalars['String']['input']>;
@@ -4806,7 +4376,7 @@ export type OrderFulfillmentsArgs = {
4806
4376
  sortKey?: InputMaybe<FulfillmentSortKeys>;
4807
4377
  };
4808
4378
 
4809
- /** A customer’s completed request to purchase one or more products from a shop. */
4379
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4810
4380
  export type OrderLineItemsArgs = {
4811
4381
  after?: InputMaybe<Scalars['String']['input']>;
4812
4382
  before?: InputMaybe<Scalars['String']['input']>;
@@ -4815,23 +4385,23 @@ export type OrderLineItemsArgs = {
4815
4385
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
4816
4386
  };
4817
4387
 
4818
- /** A customer’s completed request to purchase one or more products from a shop. */
4388
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4819
4389
  export type OrderMetafieldArgs = {
4820
4390
  key: Scalars['String']['input'];
4821
4391
  namespace: Scalars['String']['input'];
4822
4392
  };
4823
4393
 
4824
- /** A customer’s completed request to purchase one or more products from a shop. */
4394
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4825
4395
  export type OrderMetafieldsArgs = {
4826
4396
  identifiers: Array<HasMetafieldsIdentifier>;
4827
4397
  };
4828
4398
 
4829
- /** A customer’s completed request to purchase one or more products from a shop. */
4399
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4830
4400
  export type OrderReturnArgs = {
4831
4401
  id: Scalars['ID']['input'];
4832
4402
  };
4833
4403
 
4834
- /** A customer’s completed request to purchase one or more products from a shop. */
4404
+ /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
4835
4405
  export type OrderReturnsArgs = {
4836
4406
  after?: InputMaybe<Scalars['String']['input']>;
4837
4407
  before?: InputMaybe<Scalars['String']['input']>;
@@ -4844,7 +4414,6 @@ export type OrderReturnsArgs = {
4844
4414
  /**
4845
4415
  * The possible order action types for a
4846
4416
  * [sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement).
4847
- *
4848
4417
  */
4849
4418
  export type OrderActionType =
4850
4419
  /** An order with a purchase or charge. */
@@ -4909,7 +4478,6 @@ export type OrderByCompanySortKeys =
4909
4478
  /**
4910
4479
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
4911
4480
  * Don't use this sort key when no search query is specified.
4912
- *
4913
4481
  */
4914
4482
  | 'RELEVANCE'
4915
4483
  /** Sort by the `total_price` value. */
@@ -4932,7 +4500,6 @@ export type OrderByContactSortKeys =
4932
4500
  /**
4933
4501
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
4934
4502
  * Don't use this sort key when no search query is specified.
4935
- *
4936
4503
  */
4937
4504
  | 'RELEVANCE'
4938
4505
  /** Sort by the `total_price` value. */
@@ -4953,7 +4520,6 @@ export type OrderByLocationSortKeys =
4953
4520
  /**
4954
4521
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
4955
4522
  * Don't use this sort key when no search query is specified.
4956
- *
4957
4523
  */
4958
4524
  | 'RELEVANCE'
4959
4525
  /** Sort by the `total_price` value. */
@@ -4976,17 +4542,14 @@ export type OrderCancelReason =
4976
4542
  /** Staff made an error. */
4977
4543
  | 'STAFF';
4978
4544
 
4979
- /**
4980
- * An auto-generated type for paginating through multiple Orders.
4981
- *
4982
- */
4545
+ /** An auto-generated type for paginating through multiple Orders. */
4983
4546
  export type OrderConnection = {
4984
4547
  __typename?: 'OrderConnection';
4985
- /** A list of edges. */
4548
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
4986
4549
  edges: Array<OrderEdge>;
4987
- /** A list of the nodes contained in OrderEdge. */
4550
+ /** A list of nodes that are contained in OrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
4988
4551
  nodes: Array<Order>;
4989
- /** Information to aid in pagination. */
4552
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
4990
4553
  pageInfo: PageInfo;
4991
4554
  };
4992
4555
 
@@ -5008,10 +4571,7 @@ export type OrderDiscountInformation = {
5008
4571
  totalOrderLevelAppliedDiscounts: MoneyV2;
5009
4572
  };
5010
4573
 
5011
- /**
5012
- * The status of duties for the order.
5013
- *
5014
- */
4574
+ /** The status of duties for the order. */
5015
4575
  export type OrderDutiesStatusType =
5016
4576
  /** The order is being shipped from another country, so duties and taxes may be charged on delivery. */
5017
4577
  | 'DUTIES_ERROR'
@@ -5020,10 +4580,7 @@ export type OrderDutiesStatusType =
5020
4580
  /** The order is being shipped from another country. Duties are not charged on orders of this value. */
5021
4581
  | 'DUTIES_ZERO';
5022
4582
 
5023
- /**
5024
- * The summary of duties associated with an order.
5025
- *
5026
- */
4583
+ /** The summary of duties associated with an order. */
5027
4584
  export type OrderDutiesSummary = {
5028
4585
  __typename?: 'OrderDutiesSummary';
5029
4586
  /** The total amount of duties for the order. */
@@ -5032,13 +4589,10 @@ export type OrderDutiesSummary = {
5032
4589
  totalDutiesStatus?: Maybe<OrderDutiesStatusType>;
5033
4590
  };
5034
4591
 
5035
- /**
5036
- * An auto-generated type which holds one Order and a cursor during pagination.
5037
- *
5038
- */
4592
+ /** An auto-generated type which holds one Order and a cursor during pagination. */
5039
4593
  export type OrderEdge = {
5040
4594
  __typename?: 'OrderEdge';
5041
- /** A cursor for use in pagination. */
4595
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
5042
4596
  cursor: Scalars['String']['output'];
5043
4597
  /** The item at the end of OrderEdge. */
5044
4598
  node: Order;
@@ -5076,10 +4630,7 @@ export type OrderEditSummary = {
5076
4630
  latestHappenedAt?: Maybe<Scalars['DateTime']['output']>;
5077
4631
  };
5078
4632
 
5079
- /**
5080
- * A change in the edit summary of an order.
5081
- *
5082
- */
4633
+ /** A change in the edit summary of an order. */
5083
4634
  export type OrderEditSummaryChange = Node & {
5084
4635
  __typename?: 'OrderEditSummaryChange';
5085
4636
  /** The quantity delta of the change. */
@@ -5111,65 +4662,29 @@ export type OrderFinancialStatus =
5111
4662
  /** Displayed as **Voided**. */
5112
4663
  | 'VOIDED';
5113
4664
 
5114
- /**
5115
- * The aggregation of each order's active fulfillments and opened fulfillment orders for display purposes.
5116
- *
5117
- */
4665
+ /** The aggregation of each order's active fulfillments and opened fulfillment orders for display purposes. */
5118
4666
  export type OrderFulfillmentStatus =
5119
- /**
5120
- * Attempted to deliver the fulfillment.
5121
- *
5122
- */
4667
+ /** Attempted to deliver the fulfillment. */
5123
4668
  | 'ATTEMPTED_TO_DELIVER'
5124
- /**
5125
- * The order is confirmed.
5126
- *
5127
- */
4669
+ /** The order is confirmed. */
5128
4670
  | 'CONFIRMED'
5129
- /**
5130
- * Every physical fulfillment of the order has been successfully delivered.
5131
- *
5132
- */
4671
+ /** Every physical fulfillment of the order has been successfully delivered. */
5133
4672
  | 'DELIVERED'
5134
- /**
5135
- * The order has one fulfillment in transit.
5136
- *
5137
- */
4673
+ /** The order has one fulfillment in transit. */
5138
4674
  | 'IN_TRANSIT'
5139
- /**
5140
- * This order has multiple physical fulfillments with differing statuses.
5141
- *
5142
- */
4675
+ /** This order has multiple physical fulfillments with differing statuses. */
5143
4676
  | 'MULTIPLE_SHIPMENTS'
5144
- /**
5145
- * The order has one fulfillment on its way.
5146
- *
5147
- */
4677
+ /** The order has one fulfillment on its way. */
5148
4678
  | 'ON_ITS_WAY'
5149
- /**
5150
- * The order has one fulfillment out for delivery.
5151
- *
5152
- */
4679
+ /** The order has one fulfillment out for delivery. */
5153
4680
  | 'OUT_FOR_DELIVERY'
5154
- /**
5155
- * The order has been picked up.
5156
- *
5157
- */
4681
+ /** The order has been picked up. */
5158
4682
  | 'PICKED_UP'
5159
- /**
5160
- * The order has one fulfillment being prepared for shipping.
5161
- *
5162
- */
4683
+ /** The order has one fulfillment being prepared for shipping. */
5163
4684
  | 'PREPARING_FOR_SHIPPING'
5164
- /**
5165
- * The order is ready to be picked up.
5166
- *
5167
- */
4685
+ /** The order is ready to be picked up. */
5168
4686
  | 'READY_FOR_PICKUP'
5169
- /**
5170
- * There was a problem with the fulfillment.
5171
- *
5172
- */
4687
+ /** There was a problem with the fulfillment. */
5173
4688
  | 'THERE_WAS_A_PROBLEM';
5174
4689
 
5175
4690
  /** The quantitative information about the line items of a specific order. */
@@ -5219,10 +4734,7 @@ export type OrderPaymentStatus =
5219
4734
  /** The payment has been voided. */
5220
4735
  | 'VOIDED';
5221
4736
 
5222
- /**
5223
- * The pickup information associated with an order.
5224
- *
5225
- */
4737
+ /** The pickup information associated with an order. */
5226
4738
  export type OrderPickupInformation = {
5227
4739
  __typename?: 'OrderPickupInformation';
5228
4740
  /** The pickup address for the order. */
@@ -5240,6 +4752,8 @@ export type OrderRequestReturnPayload = {
5240
4752
  __typename?: 'OrderRequestReturnPayload';
5241
4753
  /** The return request that has been made. */
5242
4754
  return?: Maybe<Return>;
4755
+ /** The list of errors that occurred from executing the mutation. */
4756
+ userErrors: Array<ReturnUserError>;
5243
4757
  };
5244
4758
 
5245
4759
  /** The group including the shipping lines of the order. */
@@ -5281,7 +4795,6 @@ export type OrderSortKeys =
5281
4795
  /**
5282
4796
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
5283
4797
  * Don't use this sort key when no search query is specified.
5284
- *
5285
4798
  */
5286
4799
  | 'RELEVANCE'
5287
4800
  /** Sort by the `total_price` value. */
@@ -5344,10 +4857,7 @@ export type OrderTransactionKind =
5344
4857
  /** A void transaction. */
5345
4858
  | 'VOID';
5346
4859
 
5347
- /**
5348
- * Represents the status of an order transaction.
5349
- *
5350
- */
4860
+ /** Represents the status of an order transaction. */
5351
4861
  export type OrderTransactionStatus =
5352
4862
  /** The transaction has an error. */
5353
4863
  | 'ERROR'
@@ -5385,7 +4895,6 @@ export type OrderTransactionType =
5385
4895
  * Returns information about pagination in a connection, in accordance with the
5386
4896
  * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).
5387
4897
  * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql).
5388
- *
5389
4898
  */
5390
4899
  export type PageInfo = {
5391
4900
  __typename?: 'PageInfo';
@@ -5421,7 +4930,6 @@ export type PaymentIconImage = Node & {
5421
4930
  * The location of the original image as a URL.
5422
4931
  *
5423
4932
  * If there are any existing transformations in the original source URL, they will remain and not be stripped.
5424
- *
5425
4933
  * @deprecated Use `url` instead.
5426
4934
  */
5427
4935
  originalSrc: Scalars['URL']['output'];
@@ -5435,7 +4943,6 @@ export type PaymentIconImage = Node & {
5435
4943
  *
5436
4944
  * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be.
5437
4945
  * Otherwise any transformations which an image type doesn't support will be ignored.
5438
- *
5439
4946
  * @deprecated Use `url(transform:)` instead
5440
4947
  */
5441
4948
  transformedSrc: Scalars['URL']['output'];
@@ -5447,7 +4954,6 @@ export type PaymentIconImage = Node & {
5447
4954
  * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.
5448
4955
  *
5449
4956
  * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).
5450
- *
5451
4957
  */
5452
4958
  url: Scalars['URL']['output'];
5453
4959
  /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */
@@ -5541,27 +5047,21 @@ export type PaymentSchedule = Node & {
5541
5047
  id: Scalars['ID']['output'];
5542
5048
  };
5543
5049
 
5544
- /**
5545
- * An auto-generated type for paginating through multiple PaymentSchedules.
5546
- *
5547
- */
5050
+ /** An auto-generated type for paginating through multiple PaymentSchedules. */
5548
5051
  export type PaymentScheduleConnection = {
5549
5052
  __typename?: 'PaymentScheduleConnection';
5550
- /** A list of edges. */
5053
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
5551
5054
  edges: Array<PaymentScheduleEdge>;
5552
- /** A list of the nodes contained in PaymentScheduleEdge. */
5055
+ /** A list of nodes that are contained in PaymentScheduleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
5553
5056
  nodes: Array<PaymentSchedule>;
5554
- /** Information to aid in pagination. */
5057
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
5555
5058
  pageInfo: PageInfo;
5556
5059
  };
5557
5060
 
5558
- /**
5559
- * An auto-generated type which holds one PaymentSchedule and a cursor during pagination.
5560
- *
5561
- */
5061
+ /** An auto-generated type which holds one PaymentSchedule and a cursor during pagination. */
5562
5062
  export type PaymentScheduleEdge = {
5563
5063
  __typename?: 'PaymentScheduleEdge';
5564
- /** A cursor for use in pagination. */
5064
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
5565
5065
  cursor: Scalars['String']['output'];
5566
5066
  /** The item at the end of PaymentScheduleEdge. */
5567
5067
  node: PaymentSchedule;
@@ -5572,10 +5072,7 @@ export type PaymentTerms = Node & {
5572
5072
  __typename?: 'PaymentTerms';
5573
5073
  /** A globally-unique ID. */
5574
5074
  id: Scalars['ID']['output'];
5575
- /**
5576
- * The next due date if this is the NET or FIXED type of payment terms.
5577
- *
5578
- */
5075
+ /** The next due date if this is the NET or FIXED type of payment terms. */
5579
5076
  nextDueAt?: Maybe<Scalars['DateTime']['output']>;
5580
5077
  /** Whether the payment terms have overdue payment schedules. */
5581
5078
  overdue: Scalars['Boolean']['output'];
@@ -5680,46 +5177,22 @@ export type PaypalTokenCreatePayload = {
5680
5177
  userErrors: Array<UserErrorsPaypalTokenUserErrors>;
5681
5178
  };
5682
5179
 
5683
- /**
5684
- * The operations that can be performed on a B2B resource.
5685
- *
5686
- */
5180
+ /** The operations that can be performed on a B2B resource. */
5687
5181
  export type PermittedOperation =
5688
- /**
5689
- * The permission to add a resource.
5690
- *
5691
- */
5182
+ /** The permission to add a resource. */
5692
5183
  | 'ADD'
5693
- /**
5694
- * All permissions for a resource.
5695
- *
5696
- */
5184
+ /** All permissions for a resource. */
5697
5185
  | 'ALL'
5698
- /**
5699
- * The permission to delete a resource.
5700
- *
5701
- */
5186
+ /** The permission to delete a resource. */
5702
5187
  | 'DELETE'
5703
- /**
5704
- * The permission to edit a resource.
5705
- *
5706
- */
5188
+ /** The permission to edit a resource. */
5707
5189
  | 'EDIT'
5708
- /**
5709
- * The permission to use a resource.
5710
- *
5711
- */
5190
+ /** The permission to use a resource. */
5712
5191
  | 'USE'
5713
- /**
5714
- * The permission to view a resource.
5715
- *
5716
- */
5192
+ /** The permission to view a resource. */
5717
5193
  | 'VIEW';
5718
5194
 
5719
- /**
5720
- * The address of a pickup location.
5721
- *
5722
- */
5195
+ /** The address of a pickup location. */
5723
5196
  export type PickupAddress = {
5724
5197
  __typename?: 'PickupAddress';
5725
5198
  /** The street address for the pickup location. */
@@ -5789,24 +5262,19 @@ export type PublicOrder = Node & {
5789
5262
  /**
5790
5263
  * The date and time when the order was canceled.
5791
5264
  * Returns `null` if the order wasn't canceled.
5792
- *
5793
5265
  */
5794
5266
  cancelledAt?: Maybe<Scalars['DateTime']['output']>;
5795
5267
  /**
5796
5268
  * A randomly generated alpha-numeric identifier for the order that may be shown to the customer
5797
5269
  * instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ".
5798
5270
  * This value isn't guaranteed to be unique.
5799
- *
5800
5271
  */
5801
5272
  confirmationNumber?: Maybe<Scalars['String']['output']>;
5802
5273
  /** The discount information for the order, including line-level discount applications. */
5803
5274
  discountInformation: OrderDiscountInformation;
5804
5275
  /** The name of the associated draft order. */
5805
5276
  draftOrderName?: Maybe<Scalars['String']['output']>;
5806
- /**
5807
- * The edit summary of the order.
5808
- *
5809
- */
5277
+ /** The edit summary of the order. */
5810
5278
  editSummary?: Maybe<OrderEditSummary>;
5811
5279
  /** The financial status of the order. */
5812
5280
  financialStatus?: Maybe<OrderFinancialStatus>;
@@ -5833,7 +5301,6 @@ export type PublicOrder = Node & {
5833
5301
  /**
5834
5302
  * The identifier for the order that appears on the order.
5835
5303
  * For example, _#1000_ or _Store1001.
5836
- *
5837
5304
  */
5838
5305
  name: Scalars['String']['output'];
5839
5306
  /** The payment information for the order. */
@@ -5846,7 +5313,6 @@ export type PublicOrder = Node & {
5846
5313
  * The date and time when the order was processed.
5847
5314
  * This value can be set to dates in the past when importing from other systems.
5848
5315
  * If no value is provided, it will be auto-generated based on current date and time.
5849
- *
5850
5316
  */
5851
5317
  processedAt: Scalars['DateTime']['output'];
5852
5318
  /** A list of refunds associated with the order. */
@@ -5922,10 +5388,7 @@ export type PublicOrderReturnsArgs = {
5922
5388
  sortKey?: InputMaybe<ReturnSortKeys>;
5923
5389
  };
5924
5390
 
5925
- /**
5926
- * The information of the purchasing company for an order or draft order.
5927
- *
5928
- */
5391
+ /** The information of the purchasing company for an order or draft order. */
5929
5392
  export type PurchasingCompany = {
5930
5393
  __typename?: 'PurchasingCompany';
5931
5394
  /** The company associated with the order or draft order. */
@@ -5936,30 +5399,27 @@ export type PurchasingCompany = {
5936
5399
  location: CompanyLocation;
5937
5400
  };
5938
5401
 
5939
- /**
5940
- * Represents information about the purchasing entity for the order or draft order.
5941
- *
5942
- */
5402
+ /** Represents information about the purchasing entity for the order or draft order. */
5943
5403
  export type PurchasingEntity = Customer | PurchasingCompany;
5944
5404
 
5945
5405
  /** This acts as the public, top-level API from which all queries start. */
5946
5406
  export type QueryRoot = {
5947
5407
  __typename?: 'QueryRoot';
5948
- /** The information of the customer's company. */
5408
+ /** The information of the customer's company. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5949
5409
  company?: Maybe<Company>;
5950
- /** The Location corresponding to the provided ID. */
5410
+ /** The Location corresponding to the provided ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5951
5411
  companyLocation?: Maybe<CompanyLocation>;
5952
- /** Returns the Customer resource. */
5412
+ /** Returns the Customer resource. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5953
5413
  customer: Customer;
5954
- /** Returns a draft order resource by ID. */
5414
+ /** Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5955
5415
  draftOrder?: Maybe<DraftOrder>;
5956
5416
  /** The API tokens for UI extensions. */
5957
5417
  extensionApiTokens?: Maybe<ExtensionApiTokens>;
5958
- /** Returns an Order resource by ID. */
5418
+ /** Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5959
5419
  order?: Maybe<Order>;
5960
5420
  /** An Order resource identified by ID. */
5961
5421
  orderDetailsPageOrder?: Maybe<OrderDetailsPageOrder>;
5962
- /** Returns the information about the shop. */
5422
+ /** Returns the information about the shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
5963
5423
  shop: Shop;
5964
5424
  /**
5965
5425
  * Public metafields for Shop, Order, Customer, Company, CompanyLocation, Product, and ProductVariant.
@@ -5967,7 +5427,6 @@ export type QueryRoot = {
5967
5427
  * Product and ProductVariant are only fetched if resource_ids are provided and there is a match for the
5968
5428
  * namespace and key. Either filters or extensionIds is needed. If both are provided, filters will be used.
5969
5429
  * This is restricted to development shops for local UI extension development purposes only.
5970
- *
5971
5430
  */
5972
5431
  uiExtensionMetafields: Array<UiExtensionMetafield>;
5973
5432
  /** A session token for an UI extension. */
@@ -5992,6 +5451,7 @@ export type QueryRootDraftOrderArgs = {
5992
5451
  /** This acts as the public, top-level API from which all queries start. */
5993
5452
  export type QueryRootExtensionApiTokensArgs = {
5994
5453
  appId: Scalars['ID']['input'];
5454
+ extensionType?: InputMaybe<Scalars['String']['input']>;
5995
5455
  };
5996
5456
 
5997
5457
  /** This acts as the public, top-level API from which all queries start. */
@@ -6016,10 +5476,7 @@ export type QueryRootUiExtensionSessionTokenArgs = {
6016
5476
  id: Scalars['ID']['input'];
6017
5477
  };
6018
5478
 
6019
- /**
6020
- * The record of refunds issued to a customer.
6021
- *
6022
- */
5479
+ /** The record of refunds issued to a customer. */
6023
5480
  export type Refund = Node & {
6024
5481
  __typename?: 'Refund';
6025
5482
  /** The date and time when the refund was created. */
@@ -6059,10 +5516,7 @@ export type RefundAgreementSalesArgs = {
6059
5516
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
6060
5517
  };
6061
5518
 
6062
- /**
6063
- * The information about the line items container for items that have not been refunded or removed.
6064
- *
6065
- */
5519
+ /** The information about the line items container for items that have not been refunded or removed. */
6066
5520
  export type RemainingLineItemContainer = {
6067
5521
  __typename?: 'RemainingLineItemContainer';
6068
5522
  /** A unique ID for the container. */
@@ -6071,10 +5525,7 @@ export type RemainingLineItemContainer = {
6071
5525
  lineItems: RemainingLineItemContainerLineItemConnection;
6072
5526
  };
6073
5527
 
6074
- /**
6075
- * The information about the line items container for items that have not been refunded or removed.
6076
- *
6077
- */
5528
+ /** The information about the line items container for items that have not been refunded or removed. */
6078
5529
  export type RemainingLineItemContainerLineItemsArgs = {
6079
5530
  after?: InputMaybe<Scalars['String']['input']>;
6080
5531
  before?: InputMaybe<Scalars['String']['input']>;
@@ -6083,10 +5534,7 @@ export type RemainingLineItemContainerLineItemsArgs = {
6083
5534
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
6084
5535
  };
6085
5536
 
6086
- /**
6087
- * The information about the line item in the line item container.
6088
- *
6089
- */
5537
+ /** The information about the line item in the line item container. */
6090
5538
  export type RemainingLineItemContainerLineItem = Node & {
6091
5539
  __typename?: 'RemainingLineItemContainerLineItem';
6092
5540
  /** A globally-unique ID. */
@@ -6095,27 +5543,21 @@ export type RemainingLineItemContainerLineItem = Node & {
6095
5543
  lineItem: LineItem;
6096
5544
  };
6097
5545
 
6098
- /**
6099
- * An auto-generated type for paginating through multiple RemainingLineItemContainerLineItems.
6100
- *
6101
- */
5546
+ /** An auto-generated type for paginating through multiple RemainingLineItemContainerLineItems. */
6102
5547
  export type RemainingLineItemContainerLineItemConnection = {
6103
5548
  __typename?: 'RemainingLineItemContainerLineItemConnection';
6104
- /** A list of edges. */
5549
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6105
5550
  edges: Array<RemainingLineItemContainerLineItemEdge>;
6106
- /** A list of the nodes contained in RemainingLineItemContainerLineItemEdge. */
5551
+ /** A list of nodes that are contained in RemainingLineItemContainerLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6107
5552
  nodes: Array<RemainingLineItemContainerLineItem>;
6108
- /** Information to aid in pagination. */
5553
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6109
5554
  pageInfo: PageInfo;
6110
5555
  };
6111
5556
 
6112
- /**
6113
- * An auto-generated type which holds one RemainingLineItemContainerLineItem and a cursor during pagination.
6114
- *
6115
- */
5557
+ /** An auto-generated type which holds one RemainingLineItemContainerLineItem and a cursor during pagination. */
6116
5558
  export type RemainingLineItemContainerLineItemEdge = {
6117
5559
  __typename?: 'RemainingLineItemContainerLineItemEdge';
6118
- /** A cursor for use in pagination. */
5560
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6119
5561
  cursor: Scalars['String']['output'];
6120
5562
  /** The item at the end of RemainingLineItemContainerLineItemEdge. */
6121
5563
  node: RemainingLineItemContainerLineItem;
@@ -6127,7 +5569,6 @@ export type RequestedLineItemInput = {
6127
5569
  * A note from the customer explaining the item to be returned.
6128
5570
  * For instance, the note can detail issues with the item for the merchant's information.
6129
5571
  * Maximum length: 300 characters.
6130
- *
6131
5572
  */
6132
5573
  customerNote?: InputMaybe<Scalars['String']['input']>;
6133
5574
  /** The ID of the line item that's to be returned. */
@@ -6156,65 +5597,29 @@ export type ResourcePermission = {
6156
5597
  resource: ResourceType;
6157
5598
  };
6158
5599
 
6159
- /**
6160
- * The B2B resource types.
6161
- *
6162
- */
5600
+ /** The B2B resource types. */
6163
5601
  export type ResourceType =
6164
- /**
6165
- * The Business Profile resource type.
6166
- *
6167
- */
5602
+ /** The Business Profile resource type. */
6168
5603
  | 'BUSINESS_PROFILE'
6169
- /**
6170
- * The Company resource type.
6171
- *
6172
- */
5604
+ /** The Company resource type. */
6173
5605
  | 'COMPANY'
6174
- /**
6175
- * The Company Contact resource type.
6176
- *
6177
- */
5606
+ /** The Company Contact resource type. */
6178
5607
  | 'COMPANY_CONTACT'
6179
- /**
6180
- * The Company Contact Role resource type.
6181
- *
6182
- */
5608
+ /** The Company Contact Role resource type. */
6183
5609
  | 'COMPANY_CONTACT_ROLE'
6184
- /**
6185
- * The Company Location resource type.
6186
- *
6187
- */
5610
+ /** The Company Location resource type. */
6188
5611
  | 'COMPANY_LOCATION'
6189
- /**
6190
- * The Company Location Billing Address resource type.
6191
- *
6192
- */
5612
+ /** The Company Location Billing Address resource type. */
6193
5613
  | 'COMPANY_LOCATION_BILLING_ADDRESS'
6194
- /**
6195
- * The Company Location Shipping Address resource type.
6196
- *
6197
- */
5614
+ /** The Company Location Shipping Address resource type. */
6198
5615
  | 'COMPANY_LOCATION_SHIPPING_ADDRESS'
6199
- /**
6200
- * The Company Tax Exemption resource type.
6201
- *
6202
- */
5616
+ /** The Company Tax Exemption resource type. */
6203
5617
  | 'COMPANY_TAX_EXEMPTION'
6204
- /**
6205
- * The Draft Order resource type.
6206
- *
6207
- */
5618
+ /** The Draft Order resource type. */
6208
5619
  | 'DRAFT_ORDER'
6209
- /**
6210
- * The Order resource type.
6211
- *
6212
- */
5620
+ /** The Order resource type. */
6213
5621
  | 'ORDER'
6214
- /**
6215
- * The Payment Method resource type.
6216
- *
6217
- */
5622
+ /** The Payment Method resource type. */
6218
5623
  | 'PAYMENT_METHOD';
6219
5624
 
6220
5625
  /** A product return. */
@@ -6224,6 +5629,8 @@ export type Return = Node & {
6224
5629
  closedAt?: Maybe<Scalars['DateTime']['output']>;
6225
5630
  /** The date when the return was created. */
6226
5631
  createdAt?: Maybe<Scalars['DateTime']['output']>;
5632
+ /** The additional details about the declined return. */
5633
+ decline?: Maybe<ReturnDecline>;
6227
5634
  /** A globally-unique ID. */
6228
5635
  id: Scalars['ID']['output'];
6229
5636
  /** The name assigned to the return. */
@@ -6283,32 +5690,97 @@ export type ReturnAgreementSalesArgs = {
6283
5690
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
6284
5691
  };
6285
5692
 
6286
- /**
6287
- * An auto-generated type for paginating through multiple Returns.
6288
- *
6289
- */
5693
+ /** An auto-generated type for paginating through multiple Returns. */
6290
5694
  export type ReturnConnection = {
6291
5695
  __typename?: 'ReturnConnection';
6292
- /** A list of edges. */
5696
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6293
5697
  edges: Array<ReturnEdge>;
6294
- /** A list of the nodes contained in ReturnEdge. */
5698
+ /** A list of nodes that are contained in ReturnEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6295
5699
  nodes: Array<Return>;
6296
- /** Information to aid in pagination. */
5700
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6297
5701
  pageInfo: PageInfo;
6298
5702
  };
6299
5703
 
6300
- /**
6301
- * An auto-generated type which holds one Return and a cursor during pagination.
6302
- *
6303
- */
5704
+ /** The extra information about why a merchant declined the customer's return request. */
5705
+ export type ReturnDecline = {
5706
+ __typename?: 'ReturnDecline';
5707
+ /** The notification message that was sent to the customer about their declined return. */
5708
+ note?: Maybe<Scalars['String']['output']>;
5709
+ /** The reason for the decline. */
5710
+ reason: ReturnDeclineReason;
5711
+ };
5712
+
5713
+ /** The specific reason for the merchant declining a customer's return request. */
5714
+ export type ReturnDeclineReason =
5715
+ /** The return request was declined because it contains items from a final sale. */
5716
+ | 'FINAL_SALE'
5717
+ /** The return request was declined due to another reason. */
5718
+ | 'OTHER'
5719
+ /** The return request was declined because the return period has ended. */
5720
+ | 'RETURN_PERIOD_ENDED';
5721
+
5722
+ /** An auto-generated type which holds one Return and a cursor during pagination. */
6304
5723
  export type ReturnEdge = {
6305
5724
  __typename?: 'ReturnEdge';
6306
- /** A cursor for use in pagination. */
5725
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6307
5726
  cursor: Scalars['String']['output'];
6308
5727
  /** The item at the end of ReturnEdge. */
6309
5728
  node: Return;
6310
5729
  };
6311
5730
 
5731
+ /** Possible error codes that can be returned by `ReturnUserError`. */
5732
+ export type ReturnErrorCode =
5733
+ /** The requested resource already exists. */
5734
+ | 'ALREADY_EXISTS'
5735
+ /** The input value is blank. */
5736
+ | 'BLANK'
5737
+ /** A requested resource could not be created. */
5738
+ | 'CREATION_FAILED'
5739
+ /** The input value should be equal to the value allowed. */
5740
+ | 'EQUAL_TO'
5741
+ /** A required feature is not enabled. */
5742
+ | 'FEATURE_NOT_ENABLED'
5743
+ /** The input value should be greater than the minimum allowed value. */
5744
+ | 'GREATER_THAN'
5745
+ /** The input value should be greater than or equal to the minimum value allowed. */
5746
+ | 'GREATER_THAN_OR_EQUAL_TO'
5747
+ /** The input value isn't included in the list. */
5748
+ | 'INCLUSION'
5749
+ /** Unexpected internal error happened. */
5750
+ | 'INTERNAL_ERROR'
5751
+ /** The input value is invalid. */
5752
+ | 'INVALID'
5753
+ /** A resource was not in the correct state for the operation to succeed. */
5754
+ | 'INVALID_STATE'
5755
+ /** The input value should be less than the maximum value allowed. */
5756
+ | 'LESS_THAN'
5757
+ /** The input value should be less than or equal to the maximum value allowed. */
5758
+ | 'LESS_THAN_OR_EQUAL_TO'
5759
+ /** A requested notification could not be sent. */
5760
+ | 'NOTIFICATION_FAILED'
5761
+ /** A request is not authorized. */
5762
+ | 'NOT_AUTHORIZED'
5763
+ /** The input value is not a number. */
5764
+ | 'NOT_A_NUMBER'
5765
+ /** A requested item is not editable. */
5766
+ | 'NOT_EDITABLE'
5767
+ /** A requested item could not be found. */
5768
+ | 'NOT_FOUND'
5769
+ /** The input value needs to be blank. */
5770
+ | 'PRESENT'
5771
+ /** The input value is already taken. */
5772
+ | 'TAKEN'
5773
+ /** The input value is too big. */
5774
+ | 'TOO_BIG'
5775
+ /** The input value is too long. */
5776
+ | 'TOO_LONG'
5777
+ /** Too many arguments provided. */
5778
+ | 'TOO_MANY_ARGUMENTS'
5779
+ /** The input value is too short. */
5780
+ | 'TOO_SHORT'
5781
+ /** The input value is the wrong length. */
5782
+ | 'WRONG_LENGTH';
5783
+
6312
5784
  /** A line item that is being returned. */
6313
5785
  export type ReturnLineItem = Node & {
6314
5786
  __typename?: 'ReturnLineItem';
@@ -6322,27 +5794,21 @@ export type ReturnLineItem = Node & {
6322
5794
  returnReason: ReturnReason;
6323
5795
  };
6324
5796
 
6325
- /**
6326
- * An auto-generated type for paginating through multiple ReturnLineItems.
6327
- *
6328
- */
5797
+ /** An auto-generated type for paginating through multiple ReturnLineItems. */
6329
5798
  export type ReturnLineItemConnection = {
6330
5799
  __typename?: 'ReturnLineItemConnection';
6331
- /** A list of edges. */
5800
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6332
5801
  edges: Array<ReturnLineItemEdge>;
6333
- /** A list of the nodes contained in ReturnLineItemEdge. */
5802
+ /** A list of nodes that are contained in ReturnLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6334
5803
  nodes: Array<ReturnLineItem>;
6335
- /** Information to aid in pagination. */
5804
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6336
5805
  pageInfo: PageInfo;
6337
5806
  };
6338
5807
 
6339
- /**
6340
- * An auto-generated type which holds one ReturnLineItem and a cursor during pagination.
6341
- *
6342
- */
5808
+ /** An auto-generated type which holds one ReturnLineItem and a cursor during pagination. */
6343
5809
  export type ReturnLineItemEdge = {
6344
5810
  __typename?: 'ReturnLineItemEdge';
6345
- /** A cursor for use in pagination. */
5811
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6346
5812
  cursor: Scalars['String']['output'];
6347
5813
  /** The item at the end of ReturnLineItemEdge. */
6348
5814
  node: ReturnLineItem;
@@ -6380,7 +5846,6 @@ export type ReturnSortKeys =
6380
5846
  /**
6381
5847
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
6382
5848
  * Don't use this sort key when no search query is specified.
6383
- *
6384
5849
  */
6385
5850
  | 'RELEVANCE';
6386
5851
 
@@ -6406,12 +5871,22 @@ export type ReturnSupportedReason = {
6406
5871
  title: Scalars['String']['output'];
6407
5872
  };
6408
5873
 
5874
+ /** The errors that occur during the execution of a return mutation. */
5875
+ export type ReturnUserError = DisplayableError & {
5876
+ __typename?: 'ReturnUserError';
5877
+ /** The error code. */
5878
+ code?: Maybe<ReturnErrorCode>;
5879
+ /** The path to the input field that caused the error. */
5880
+ field?: Maybe<Array<Scalars['String']['output']>>;
5881
+ /** The error message. */
5882
+ message: Scalars['String']['output'];
5883
+ };
5884
+
6409
5885
  /**
6410
5886
  * A reverse delivery represents a package being sent back by a buyer to a merchant post-fulfillment.
6411
5887
  * This could occur when a buyer requests a return and the merchant provides a shipping label.
6412
5888
  * The reverse delivery includes the context of the items being returned, the method of return
6413
5889
  * (for example, a shipping label), and the current status of the delivery (tracking information).
6414
- *
6415
5890
  */
6416
5891
  export type ReverseDelivery = Node & {
6417
5892
  __typename?: 'ReverseDelivery';
@@ -6423,30 +5898,24 @@ export type ReverseDelivery = Node & {
6423
5898
  id: Scalars['ID']['output'];
6424
5899
  };
6425
5900
 
6426
- /**
6427
- * An auto-generated type for paginating through multiple ReverseDeliveries.
6428
- *
6429
- */
5901
+ /** An auto-generated type for paginating through multiple ReverseDeliveries. */
6430
5902
  export type ReverseDeliveryConnection = {
6431
5903
  __typename?: 'ReverseDeliveryConnection';
6432
- /** A list of edges. */
5904
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6433
5905
  edges: Array<ReverseDeliveryEdge>;
6434
- /** A list of the nodes contained in ReverseDeliveryEdge. */
5906
+ /** A list of nodes that are contained in ReverseDeliveryEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6435
5907
  nodes: Array<ReverseDelivery>;
6436
- /** Information to aid in pagination. */
5908
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6437
5909
  pageInfo: PageInfo;
6438
5910
  };
6439
5911
 
6440
5912
  /** The method and associated details of a reverse delivery. */
6441
5913
  export type ReverseDeliveryDeliverable = ReverseDeliveryShippingDeliverable;
6442
-
6443
- /**
6444
- * An auto-generated type which holds one ReverseDelivery and a cursor during pagination.
6445
- *
6446
- */
5914
+
5915
+ /** An auto-generated type which holds one ReverseDelivery and a cursor during pagination. */
6447
5916
  export type ReverseDeliveryEdge = {
6448
5917
  __typename?: 'ReverseDeliveryEdge';
6449
- /** A cursor for use in pagination. */
5918
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6450
5919
  cursor: Scalars['String']['output'];
6451
5920
  /** The item at the end of ReverseDeliveryEdge. */
6452
5921
  node: ReverseDelivery;
@@ -6489,7 +5958,6 @@ export type ReverseDeliveryTracking = {
6489
5958
  * To address this, the remaining currency units that couldn't be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for.
6490
5959
  * In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts.
6491
5960
  * This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items.
6492
- *
6493
5961
  */
6494
5962
  export type Sale = {
6495
5963
  /** The type of order action represented by the sale. */
@@ -6523,15 +5991,12 @@ export type SaleActionType =
6523
5991
  /** A change to the price, taxes, or discounts for a previous purchase. */
6524
5992
  | 'UPDATE';
6525
5993
 
6526
- /**
6527
- * An auto-generated type for paginating through multiple Sales.
6528
- *
6529
- */
5994
+ /** An auto-generated type for paginating through multiple Sales. */
6530
5995
  export type SaleConnection = {
6531
5996
  __typename?: 'SaleConnection';
6532
- /** A list of edges. */
5997
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6533
5998
  edges: Array<SaleEdge>;
6534
- /** A list of the nodes contained in SaleEdge. */
5999
+ /** A list of nodes that are contained in SaleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6535
6000
  nodes: Array<
6536
6001
  | AdditionalFeeSale
6537
6002
  | AdjustmentSale
@@ -6543,17 +6008,14 @@ export type SaleConnection = {
6543
6008
  | TipSale
6544
6009
  | UnknownSale
6545
6010
  >;
6546
- /** Information to aid in pagination. */
6011
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6547
6012
  pageInfo: PageInfo;
6548
6013
  };
6549
6014
 
6550
- /**
6551
- * An auto-generated type which holds one Sale and a cursor during pagination.
6552
- *
6553
- */
6015
+ /** An auto-generated type which holds one Sale and a cursor during pagination. */
6554
6016
  export type SaleEdge = {
6555
6017
  __typename?: 'SaleEdge';
6556
- /** A cursor for use in pagination. */
6018
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6557
6019
  cursor: Scalars['String']['output'];
6558
6020
  /** The item at the end of SaleEdge. */
6559
6021
  node:
@@ -6572,7 +6034,6 @@ export type SaleEdge = {
6572
6034
  * The possible line types of a sale record. A sale can be an adjustment, which occurs when a refund is issued for a line item that is either more or less than the total value of the line item.
6573
6035
  * Examples include restocking fees and goodwill payments. In such cases, Shopify generates a sales agreement with sale records for each line item that is returned or refunded, and an additional sale record for the adjustment, for example a restocking fee.
6574
6036
  * The sale records for the returned or refunded items represent the reversal of the original line item sale value. The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded.
6575
- *
6576
6037
  */
6577
6038
  export type SaleLineType =
6578
6039
  /** An additional fee. */
@@ -6626,38 +6087,29 @@ export type SalesAgreementSalesArgs = {
6626
6087
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
6627
6088
  };
6628
6089
 
6629
- /**
6630
- * An auto-generated type for paginating through multiple SalesAgreements.
6631
- *
6632
- */
6090
+ /** An auto-generated type for paginating through multiple SalesAgreements. */
6633
6091
  export type SalesAgreementConnection = {
6634
6092
  __typename?: 'SalesAgreementConnection';
6635
- /** A list of edges. */
6093
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6636
6094
  edges: Array<SalesAgreementEdge>;
6637
- /** A list of the nodes contained in SalesAgreementEdge. */
6095
+ /** A list of nodes that are contained in SalesAgreementEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6638
6096
  nodes: Array<
6639
6097
  OrderAgreement | OrderEditAgreement | RefundAgreement | ReturnAgreement
6640
6098
  >;
6641
- /** Information to aid in pagination. */
6099
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6642
6100
  pageInfo: PageInfo;
6643
6101
  };
6644
6102
 
6645
- /**
6646
- * An auto-generated type which holds one SalesAgreement and a cursor during pagination.
6647
- *
6648
- */
6103
+ /** An auto-generated type which holds one SalesAgreement and a cursor during pagination. */
6649
6104
  export type SalesAgreementEdge = {
6650
6105
  __typename?: 'SalesAgreementEdge';
6651
- /** A cursor for use in pagination. */
6106
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
6652
6107
  cursor: Scalars['String']['output'];
6653
6108
  /** The item at the end of SalesAgreementEdge. */
6654
6109
  node: OrderAgreement | OrderEditAgreement | RefundAgreement | ReturnAgreement;
6655
6110
  };
6656
6111
 
6657
- /**
6658
- * Captures the intentions of a discount that was created by a Shopify Script.
6659
- *
6660
- */
6112
+ /** Captures the intentions of a discount that was created by a Shopify Script. */
6661
6113
  export type ScriptDiscountApplication = DiscountApplication & {
6662
6114
  __typename?: 'ScriptDiscountApplication';
6663
6115
  /** The method by which the discount's value is allocated to its entitled items. */
@@ -6672,64 +6124,6 @@ export type ScriptDiscountApplication = DiscountApplication & {
6672
6124
  value: PricingValue;
6673
6125
  };
6674
6126
 
6675
- /** Represents a selling plan policy anchor. */
6676
- export type SellingPlanAnchor = {
6677
- __typename?: 'SellingPlanAnchor';
6678
- /**
6679
- * The cutoff day for the anchor.
6680
- *
6681
- * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets
6682
- * the days of the week according to ISO 8601, where 1 is Monday.
6683
- *
6684
- * If `type` is MONTHDAY, then the value must be between 1-31.
6685
- *
6686
- * If `type` is YEARDAY, then the value must be `null`.
6687
- *
6688
- */
6689
- cutoffDay?: Maybe<Scalars['Int']['output']>;
6690
- /**
6691
- * The day of the anchor.
6692
- *
6693
- * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets
6694
- * the days of the week according to ISO 8601, where 1 is Monday.
6695
- *
6696
- * If `type` isn't WEEKDAY, then the value must be between 1-31.
6697
- *
6698
- */
6699
- day: Scalars['Int']['output'];
6700
- /**
6701
- * The month of the anchor. If type is different than YEARDAY, then the value must
6702
- * be `null` or between 1-12.
6703
- *
6704
- */
6705
- month?: Maybe<Scalars['Int']['output']>;
6706
- /**
6707
- * Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY.
6708
- *
6709
- */
6710
- type: SellingPlanAnchorType;
6711
- };
6712
-
6713
- /** Defines the anchor type. */
6714
- export type SellingPlanAnchorType =
6715
- /** Represents a day of the month, between 1-31. */
6716
- | 'MONTHDAY'
6717
- /** Represents a day of the week, between 1-7. */
6718
- | 'WEEKDAY'
6719
- /** Represents days of the month and year, month between 1-12, and day between 1-31. */
6720
- | 'YEARDAY';
6721
-
6722
- /** Defines valid selling plan intervals. */
6723
- export type SellingPlanInterval =
6724
- /** Represents a day interval. */
6725
- | 'DAY'
6726
- /** Represents a month interval. */
6727
- | 'MONTH'
6728
- /** Represents a week interval. */
6729
- | 'WEEK'
6730
- /** Represents a year interval. */
6731
- | 'YEAR';
6732
-
6733
6127
  /** Represents the shipping details that the customer chose for their order. */
6734
6128
  export type ShippingLine = {
6735
6129
  __typename?: 'ShippingLine';
@@ -6791,7 +6185,6 @@ export type Shop = HasMetafields &
6791
6185
  /**
6792
6186
  * The metafields associated with the resource matching the
6793
6187
  * supplied list of namespaces and keys.
6794
- *
6795
6188
  */
6796
6189
  metafields: Array<Maybe<Metafield>>;
6797
6190
  /** The shop's .myshopify.com domain name. */
@@ -6818,70 +6211,31 @@ export type ShopMetafieldsArgs = {
6818
6211
  /** The shop app links and resources for an order. */
6819
6212
  export type ShopAppLinksAndResources = {
6820
6213
  __typename?: 'ShopAppLinksAndResources';
6821
- /**
6822
- * Whether the the buyer is associated to Shop App.
6823
- *
6824
- */
6214
+ /** Whether the the buyer is associated to Shop App. */
6825
6215
  buyerHasShopApp: Scalars['Boolean']['output'];
6826
- /**
6827
- * Whether the the buyer is associated to Shop Pay.
6828
- *
6829
- */
6216
+ /** Whether the the buyer is associated to Shop Pay. */
6830
6217
  buyerHasShopPay: Scalars['Boolean']['output'];
6831
- /**
6832
- * Whether or not the track order updates button should be rendered.
6833
- *
6834
- */
6218
+ /** Whether or not the track order updates button should be rendered. */
6835
6219
  canTrackOrderUpdates: Scalars['Boolean']['output'];
6836
- /**
6837
- * Whether or not showing the installments highlight is eligible.
6838
- *
6839
- */
6220
+ /** Whether or not showing the installments highlight is eligible. */
6840
6221
  installmentsHighlightEligible: Scalars['Boolean']['output'];
6841
- /**
6842
- * The URL to the mobile Shop App.
6843
- *
6844
- */
6222
+ /** The URL to the mobile Shop App. */
6845
6223
  mobileUrl: Scalars['URL']['output'];
6846
- /**
6847
- * The attribution details related to the mobile url.
6848
- *
6849
- */
6224
+ /** The attribution details related to the mobile url. */
6850
6225
  mobileUrlAttributionPayload: Scalars['String']['output'];
6851
- /**
6852
- * The various options that exist for subscribing to order updates.
6853
- *
6854
- */
6226
+ /** The various options that exist for subscribing to order updates. */
6855
6227
  orderUpdateOptions: Array<Scalars['String']['output']>;
6856
- /**
6857
- * The URL to the Shop App QR code.
6858
- *
6859
- */
6228
+ /** The URL to the Shop App QR code. */
6860
6229
  qrCodeUrl: Scalars['URL']['output'];
6861
- /**
6862
- * Whether or not Shop App eligible.
6863
- *
6864
- */
6230
+ /** Whether or not Shop App eligible. */
6865
6231
  shopAppEligible: Scalars['Boolean']['output'];
6866
- /**
6867
- * Whether QR code should be hidden.
6868
- *
6869
- */
6232
+ /** Whether QR code should be hidden. */
6870
6233
  shopAppQrCodeKillswitch: Scalars['Boolean']['output'];
6871
- /**
6872
- * The URL to the Shop Pay Installments reminders.
6873
- *
6874
- */
6234
+ /** The URL to the Shop Pay Installments reminders. */
6875
6235
  shopInstallmentsMobileUrl: Scalars['URL']['output'];
6876
- /**
6877
- * The URL to view the Shop Pay Installments schedules in the mobile Shop App.
6878
- *
6879
- */
6236
+ /** The URL to view the Shop Pay Installments schedules in the mobile Shop App. */
6880
6237
  shopInstallmentsViewSchedules: Scalars['URL']['output'];
6881
- /**
6882
- * Whether the order was a shop pay order.
6883
- *
6884
- */
6238
+ /** Whether the order was a shop pay order. */
6885
6239
  shopPayOrder: Scalars['Boolean']['output'];
6886
6240
  };
6887
6241
 
@@ -6920,35 +6274,17 @@ export type ShopPolicy = Node & {
6920
6274
  url: Scalars['URL']['output'];
6921
6275
  };
6922
6276
 
6923
- /**
6924
- * Defines the valid SMS marketing states for a customer’s phone number.
6925
- *
6926
- */
6277
+ /** Defines the valid SMS marketing states for a customer’s phone number. */
6927
6278
  export type SmsMarketingState =
6928
- /**
6929
- * The customer has not subscribed to SMS marketing.
6930
- *
6931
- */
6279
+ /** The customer has not subscribed to SMS marketing. */
6932
6280
  | 'NOT_SUBSCRIBED'
6933
- /**
6934
- * The customer is in the process of subscribing to SMS marketing.
6935
- *
6936
- */
6281
+ /** The customer is in the process of subscribing to SMS marketing. */
6937
6282
  | 'PENDING'
6938
- /**
6939
- * The customer's personal data has been erased. This value is internally-set and read-only.
6940
- *
6941
- */
6283
+ /** The customer's personal data has been erased. This value is internally-set and read-only. */
6942
6284
  | 'REDACTED'
6943
- /**
6944
- * The customer has subscribed to SMS marketing.
6945
- *
6946
- */
6285
+ /** The customer has subscribed to SMS marketing. */
6947
6286
  | 'SUBSCRIBED'
6948
- /**
6949
- * The customer is not currently subscribed to SMS marketing but was previously subscribed.
6950
- *
6951
- */
6287
+ /** The customer is not currently subscribed to SMS marketing but was previously subscribed. */
6952
6288
  | 'UNSUBSCRIBED';
6953
6289
 
6954
6290
  /**
@@ -6956,7 +6292,6 @@ export type SmsMarketingState =
6956
6292
  * The account is held in the specified currency and has an owner that cannot be transferred.
6957
6293
  *
6958
6294
  * The account balance is redeemable at checkout only when the owner is authenticated via [new customer accounts authentication](https://shopify.dev/docs/api/customer).
6959
- *
6960
6295
  */
6961
6296
  export type StoreCreditAccount = Node & {
6962
6297
  __typename?: 'StoreCreditAccount';
@@ -6973,7 +6308,6 @@ export type StoreCreditAccount = Node & {
6973
6308
  * The account is held in the specified currency and has an owner that cannot be transferred.
6974
6309
  *
6975
6310
  * The account balance is redeemable at checkout only when the owner is authenticated via [new customer accounts authentication](https://shopify.dev/docs/api/customer).
6976
- *
6977
6311
  */
6978
6312
  export type StoreCreditAccountTransactionsArgs = {
6979
6313
  after?: InputMaybe<Scalars['String']['input']>;
@@ -6985,17 +6319,14 @@ export type StoreCreditAccountTransactionsArgs = {
6985
6319
  sortKey?: InputMaybe<TransactionSortKeys>;
6986
6320
  };
6987
6321
 
6988
- /**
6989
- * An auto-generated type for paginating through multiple StoreCreditAccounts.
6990
- *
6991
- */
6322
+ /** An auto-generated type for paginating through multiple StoreCreditAccounts. */
6992
6323
  export type StoreCreditAccountConnection = {
6993
6324
  __typename?: 'StoreCreditAccountConnection';
6994
- /** A list of edges. */
6325
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
6995
6326
  edges: Array<StoreCreditAccountEdge>;
6996
- /** A list of the nodes contained in StoreCreditAccountEdge. */
6327
+ /** A list of nodes that are contained in StoreCreditAccountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
6997
6328
  nodes: Array<StoreCreditAccount>;
6998
- /** Information to aid in pagination. */
6329
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
6999
6330
  pageInfo: PageInfo;
7000
6331
  };
7001
6332
 
@@ -7003,15 +6334,9 @@ export type StoreCreditAccountConnection = {
7003
6334
  export type StoreCreditAccountCreditTransaction = Node &
7004
6335
  StoreCreditAccountTransaction & {
7005
6336
  __typename?: 'StoreCreditAccountCreditTransaction';
7006
- /**
7007
- * The store credit account that the transaction belongs to.
7008
- *
7009
- */
6337
+ /** The store credit account that the transaction belongs to. */
7010
6338
  account: StoreCreditAccount;
7011
- /**
7012
- * The amount of the transaction.
7013
- *
7014
- */
6339
+ /** The amount of the transaction. */
7015
6340
  amount: MoneyV2;
7016
6341
  /** The balance of the account after the transaction. */
7017
6342
  balanceAfterTransaction: MoneyV2;
@@ -7020,7 +6345,6 @@ export type StoreCreditAccountCreditTransaction = Node &
7020
6345
  /**
7021
6346
  * The time at which the transaction expires.
7022
6347
  * Debit transactions will always spend the soonest expiring credit first.
7023
- *
7024
6348
  */
7025
6349
  expiresAt?: Maybe<Scalars['DateTime']['output']>;
7026
6350
  /** A globally-unique ID. */
@@ -7029,7 +6353,6 @@ export type StoreCreditAccountCreditTransaction = Node &
7029
6353
  * The remaining amount of the credit.
7030
6354
  * The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted.
7031
6355
  * In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred.
7032
- *
7033
6356
  */
7034
6357
  remainingAmount: MoneyV2;
7035
6358
  };
@@ -7040,20 +6363,13 @@ export type StoreCreditAccountCreditTransaction = Node &
7040
6363
  *
7041
6364
  * Store credit account debit transactions are reverted when an order is cancelled, refunded or in the event of a payment failure at checkout.
7042
6365
  * The amount added to the balance is equal to the amount reverted on the original credit.
7043
- *
7044
6366
  */
7045
6367
  export type StoreCreditAccountDebitRevertTransaction = Node &
7046
6368
  StoreCreditAccountTransaction & {
7047
6369
  __typename?: 'StoreCreditAccountDebitRevertTransaction';
7048
- /**
7049
- * The store credit account that the transaction belongs to.
7050
- *
7051
- */
6370
+ /** The store credit account that the transaction belongs to. */
7052
6371
  account: StoreCreditAccount;
7053
- /**
7054
- * The amount of the transaction.
7055
- *
7056
- */
6372
+ /** The amount of the transaction. */
7057
6373
  amount: MoneyV2;
7058
6374
  /** The balance of the account after the transaction. */
7059
6375
  balanceAfterTransaction: MoneyV2;
@@ -7069,15 +6385,9 @@ export type StoreCreditAccountDebitRevertTransaction = Node &
7069
6385
  export type StoreCreditAccountDebitTransaction = Node &
7070
6386
  StoreCreditAccountTransaction & {
7071
6387
  __typename?: 'StoreCreditAccountDebitTransaction';
7072
- /**
7073
- * The store credit account that the transaction belongs to.
7074
- *
7075
- */
6388
+ /** The store credit account that the transaction belongs to. */
7076
6389
  account: StoreCreditAccount;
7077
- /**
7078
- * The amount of the transaction.
7079
- *
7080
- */
6390
+ /** The amount of the transaction. */
7081
6391
  amount: MoneyV2;
7082
6392
  /** The balance of the account after the transaction. */
7083
6393
  balanceAfterTransaction: MoneyV2;
@@ -7087,13 +6397,10 @@ export type StoreCreditAccountDebitTransaction = Node &
7087
6397
  id: Scalars['ID']['output'];
7088
6398
  };
7089
6399
 
7090
- /**
7091
- * An auto-generated type which holds one StoreCreditAccount and a cursor during pagination.
7092
- *
7093
- */
6400
+ /** An auto-generated type which holds one StoreCreditAccount and a cursor during pagination. */
7094
6401
  export type StoreCreditAccountEdge = {
7095
6402
  __typename?: 'StoreCreditAccountEdge';
7096
- /** A cursor for use in pagination. */
6403
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
7097
6404
  cursor: Scalars['String']['output'];
7098
6405
  /** The item at the end of StoreCreditAccountEdge. */
7099
6406
  node: StoreCreditAccount;
@@ -7104,20 +6411,13 @@ export type StoreCreditAccountEdge = {
7104
6411
  * Expiration transactions are created automatically when a [store credit account credit transaction](https://shopify.dev/api/admin-graphql/latest/objects/StoreCreditAccountCreditTransaction) expires.
7105
6412
  *
7106
6413
  * The amount subtracted from the balance is equal to the remaining amount of the credit transaction.
7107
- *
7108
6414
  */
7109
6415
  export type StoreCreditAccountExpirationTransaction =
7110
6416
  StoreCreditAccountTransaction & {
7111
6417
  __typename?: 'StoreCreditAccountExpirationTransaction';
7112
- /**
7113
- * The store credit account that the transaction belongs to.
7114
- *
7115
- */
6418
+ /** The store credit account that the transaction belongs to. */
7116
6419
  account: StoreCreditAccount;
7117
- /**
7118
- * The amount of the transaction.
7119
- *
7120
- */
6420
+ /** The amount of the transaction. */
7121
6421
  amount: MoneyV2;
7122
6422
  /** The balance of the account after the transaction. */
7123
6423
  balanceAfterTransaction: MoneyV2;
@@ -7129,15 +6429,9 @@ export type StoreCreditAccountExpirationTransaction =
7129
6429
 
7130
6430
  /** Interface for a store credit account transaction. */
7131
6431
  export type StoreCreditAccountTransaction = {
7132
- /**
7133
- * The store credit account that the transaction belongs to.
7134
- *
7135
- */
6432
+ /** The store credit account that the transaction belongs to. */
7136
6433
  account: StoreCreditAccount;
7137
- /**
7138
- * The amount of the transaction.
7139
- *
7140
- */
6434
+ /** The amount of the transaction. */
7141
6435
  amount: MoneyV2;
7142
6436
  /** The balance of the account after the transaction. */
7143
6437
  balanceAfterTransaction: MoneyV2;
@@ -7145,32 +6439,26 @@ export type StoreCreditAccountTransaction = {
7145
6439
  createdAt: Scalars['DateTime']['output'];
7146
6440
  };
7147
6441
 
7148
- /**
7149
- * An auto-generated type for paginating through multiple StoreCreditAccountTransactions.
7150
- *
7151
- */
6442
+ /** An auto-generated type for paginating through multiple StoreCreditAccountTransactions. */
7152
6443
  export type StoreCreditAccountTransactionConnection = {
7153
6444
  __typename?: 'StoreCreditAccountTransactionConnection';
7154
- /** A list of edges. */
6445
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
7155
6446
  edges: Array<StoreCreditAccountTransactionEdge>;
7156
- /** A list of the nodes contained in StoreCreditAccountTransactionEdge. */
6447
+ /** A list of nodes that are contained in StoreCreditAccountTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
7157
6448
  nodes: Array<
7158
6449
  | StoreCreditAccountCreditTransaction
7159
6450
  | StoreCreditAccountDebitRevertTransaction
7160
6451
  | StoreCreditAccountDebitTransaction
7161
6452
  | StoreCreditAccountExpirationTransaction
7162
6453
  >;
7163
- /** Information to aid in pagination. */
6454
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
7164
6455
  pageInfo: PageInfo;
7165
6456
  };
7166
6457
 
7167
- /**
7168
- * An auto-generated type which holds one StoreCreditAccountTransaction and a cursor during pagination.
7169
- *
7170
- */
6458
+ /** An auto-generated type which holds one StoreCreditAccountTransaction and a cursor during pagination. */
7171
6459
  export type StoreCreditAccountTransactionEdge = {
7172
6460
  __typename?: 'StoreCreditAccountTransactionEdge';
7173
- /** A cursor for use in pagination. */
6461
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
7174
6462
  cursor: Scalars['String']['output'];
7175
6463
  /** The item at the end of StoreCreditAccountTransactionEdge. */
7176
6464
  node:
@@ -7189,6 +6477,12 @@ export type StorefrontCustomerAccessTokenCreatePayload = {
7189
6477
  userErrors: Array<UserErrorsStorefrontCustomerAccessTokenCreateUserErrors>;
7190
6478
  };
7191
6479
 
6480
+ /** Represents a subscription anchor. */
6481
+ export type SubscriptionAnchor =
6482
+ | SubscriptionMonthDayAnchor
6483
+ | SubscriptionWeekDayAnchor
6484
+ | SubscriptionYearDayAnchor;
6485
+
7192
6486
  /** The billing cycle of a subscription. */
7193
6487
  export type SubscriptionBillingCycle = {
7194
6488
  __typename?: 'SubscriptionBillingCycle';
@@ -7215,27 +6509,21 @@ export type SubscriptionBillingCycleBillingCycleStatus =
7215
6509
  /** The billing cycle has not been billed. */
7216
6510
  | 'UNBILLED';
7217
6511
 
7218
- /**
7219
- * An auto-generated type for paginating through multiple SubscriptionBillingCycles.
7220
- *
7221
- */
6512
+ /** An auto-generated type for paginating through multiple SubscriptionBillingCycles. */
7222
6513
  export type SubscriptionBillingCycleConnection = {
7223
6514
  __typename?: 'SubscriptionBillingCycleConnection';
7224
- /** A list of edges. */
6515
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
7225
6516
  edges: Array<SubscriptionBillingCycleEdge>;
7226
- /** A list of the nodes contained in SubscriptionBillingCycleEdge. */
6517
+ /** A list of nodes that are contained in SubscriptionBillingCycleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
7227
6518
  nodes: Array<SubscriptionBillingCycle>;
7228
- /** Information to aid in pagination. */
6519
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
7229
6520
  pageInfo: PageInfo;
7230
6521
  };
7231
6522
 
7232
- /**
7233
- * An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination.
7234
- *
7235
- */
6523
+ /** An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination. */
7236
6524
  export type SubscriptionBillingCycleEdge = {
7237
6525
  __typename?: 'SubscriptionBillingCycleEdge';
7238
- /** A cursor for use in pagination. */
6526
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
7239
6527
  cursor: Scalars['String']['output'];
7240
6528
  /** The item at the end of SubscriptionBillingCycleEdge. */
7241
6529
  node: SubscriptionBillingCycle;
@@ -7318,7 +6606,6 @@ export type SubscriptionBillingCyclesSortKeys =
7318
6606
  /**
7319
6607
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
7320
6608
  * Don't use this sort key when no search query is specified.
7321
- *
7322
6609
  */
7323
6610
  | 'RELEVANCE';
7324
6611
 
@@ -7326,11 +6613,11 @@ export type SubscriptionBillingCyclesSortKeys =
7326
6613
  export type SubscriptionBillingPolicy = {
7327
6614
  __typename?: 'SubscriptionBillingPolicy';
7328
6615
  /** The anchor dates for calculating billing intervals. */
7329
- anchors: Array<SellingPlanAnchor>;
6616
+ anchors: Array<SubscriptionAnchor>;
7330
6617
  /** The type of interval associated with this schedule (e.g. Monthly, Weekly, etc). */
7331
- interval: SellingPlanInterval;
6618
+ interval: SubscriptionInterval;
7332
6619
  /** The number of intervals between invoices. */
7333
- intervalCount: Scalars['Int']['output'];
6620
+ intervalCount?: Maybe<Count>;
7334
6621
  /** The maximum number of cycles after which the subscription ends. */
7335
6622
  maxCycles?: Maybe<Scalars['Int']['output']>;
7336
6623
  /** The minimum number of cycles required for the subscription. */
@@ -7359,12 +6646,16 @@ export type SubscriptionContract = Node &
7359
6646
  deliveryPrice: MoneyV2;
7360
6647
  /** A globally-unique ID. */
7361
6648
  id: Scalars['ID']['output'];
6649
+ /** The last billing error type of the contract. */
6650
+ lastBillingAttemptErrorType?: Maybe<SubscriptionContractLastBillingErrorType>;
7362
6651
  /** The current status of the last payment. */
7363
6652
  lastPaymentStatus?: Maybe<SubscriptionContractLastPaymentStatus>;
7364
6653
  /** The number of lines associated with the subscription contract. */
7365
6654
  lineCount: Scalars['Int']['output'];
7366
6655
  /** A list of subscription lines associated with the subscription contract. */
7367
6656
  lines: SubscriptionLineConnection;
6657
+ /** The number of lines associated with the subscription contract. */
6658
+ linesCount?: Maybe<Count>;
7368
6659
  /** The next billing date for the subscription contract. */
7369
6660
  nextBillingDate?: Maybe<Scalars['DateTime']['output']>;
7370
6661
  /** A note that will be applied to the generated orders. */
@@ -7440,6 +6731,8 @@ export type SubscriptionContractBase = {
7440
6731
  lineCount: Scalars['Int']['output'];
7441
6732
  /** A list of subscription lines associated with the subscription contract. */
7442
6733
  lines: SubscriptionLineConnection;
6734
+ /** The number of lines associated with the subscription contract. */
6735
+ linesCount?: Maybe<Count>;
7443
6736
  /** A note that will be applied to the generated orders. */
7444
6737
  note?: Maybe<Scalars['String']['output']>;
7445
6738
  /** A list of the subscription contract's orders. */
@@ -7486,27 +6779,21 @@ export type SubscriptionContractChangePaymentInstrumentPayload = {
7486
6779
  userErrors: Array<SubscriptionContractUserError>;
7487
6780
  };
7488
6781
 
7489
- /**
7490
- * An auto-generated type for paginating through multiple SubscriptionContracts.
7491
- *
7492
- */
6782
+ /** An auto-generated type for paginating through multiple SubscriptionContracts. */
7493
6783
  export type SubscriptionContractConnection = {
7494
6784
  __typename?: 'SubscriptionContractConnection';
7495
- /** A list of edges. */
6785
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
7496
6786
  edges: Array<SubscriptionContractEdge>;
7497
- /** A list of the nodes contained in SubscriptionContractEdge. */
6787
+ /** A list of nodes that are contained in SubscriptionContractEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
7498
6788
  nodes: Array<SubscriptionContract>;
7499
- /** Information to aid in pagination. */
6789
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
7500
6790
  pageInfo: PageInfo;
7501
6791
  };
7502
6792
 
7503
- /**
7504
- * An auto-generated type which holds one SubscriptionContract and a cursor during pagination.
7505
- *
7506
- */
6793
+ /** An auto-generated type which holds one SubscriptionContract and a cursor during pagination. */
7507
6794
  export type SubscriptionContractEdge = {
7508
6795
  __typename?: 'SubscriptionContractEdge';
7509
- /** A cursor for use in pagination. */
6796
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
7510
6797
  cursor: Scalars['String']['output'];
7511
6798
  /** The item at the end of SubscriptionContractEdge. */
7512
6799
  node: SubscriptionContract;
@@ -7521,6 +6808,17 @@ export type SubscriptionContractFetchDeliveryOptionsPayload = {
7521
6808
  userErrors: Array<SubscriptionContractUserError>;
7522
6809
  };
7523
6810
 
6811
+ /** The possible values of the last billing error on a subscription contract. */
6812
+ export type SubscriptionContractLastBillingErrorType =
6813
+ /** Subscription billing attempt error due to customer error. */
6814
+ | 'CUSTOMER_ERROR'
6815
+ /** Subscription billing attempt error due to inventory error. */
6816
+ | 'INVENTORY_ERROR'
6817
+ /** All other billing attempt errors. */
6818
+ | 'OTHER'
6819
+ /** Subscription billing attempt error due to payment error. */
6820
+ | 'PAYMENT_ERROR';
6821
+
7524
6822
  /** The status of the last payment on a subscription contract. */
7525
6823
  export type SubscriptionContractLastPaymentStatus =
7526
6824
  /** A failed subscription billing attempt. */
@@ -7618,7 +6916,6 @@ export type SubscriptionContractsSortKeys =
7618
6916
  /**
7619
6917
  * Sort by relevance to the search terms when the `query` parameter is specified on the connection.
7620
6918
  * Don't use this sort key when no search query is specified.
7621
- *
7622
6919
  */
7623
6920
  | 'RELEVANCE'
7624
6921
  /** Sort by the `updated_at` value. */
@@ -7634,7 +6931,6 @@ export type SubscriptionDeliveryMethod =
7634
6931
  * Specifies delivery method fields for a subscription contract.
7635
6932
  * This is an input union: one, and only one, field can be provided.
7636
6933
  * The field provided will determine which delivery method is to be used.
7637
- *
7638
6934
  */
7639
6935
  export type SubscriptionDeliveryMethodInput = {
7640
6936
  /** The input fields for the local delivery method. */
@@ -7657,13 +6953,14 @@ export type SubscriptionDeliveryMethodLocalDelivery = {
7657
6953
  /** The input fields for a local delivery method. */
7658
6954
  export type SubscriptionDeliveryMethodLocalDeliveryInput = {
7659
6955
  /** The address to deliver to. */
7660
- address: CustomerMailingAddressInput;
6956
+ address?: InputMaybe<CustomerMailingAddressInput>;
6957
+ /** The address to deliver to. */
6958
+ deliveryAddress?: InputMaybe<CustomerAddressInput>;
7661
6959
  /** The delivery instructions that the customer can provide to the merchant. */
7662
6960
  instructions?: InputMaybe<Scalars['String']['input']>;
7663
6961
  /**
7664
6962
  * The phone number that the customer must provide to the merchant.
7665
6963
  * Formatted using E.164 standard. For example, `+16135551111`.
7666
- *
7667
6964
  */
7668
6965
  phone: Scalars['String']['input'];
7669
6966
  };
@@ -7678,7 +6975,6 @@ export type SubscriptionDeliveryMethodLocalDeliveryOption = {
7678
6975
  /**
7679
6976
  * The phone number of the customer provided to the merchant.
7680
6977
  * Formatted using E.164 standard. For example, `+16135551111`.
7681
- *
7682
6978
  */
7683
6979
  phone: Scalars['String']['output'];
7684
6980
  /** The displayed title of the delivery option. */
@@ -7725,7 +7021,9 @@ export type SubscriptionDeliveryMethodShipping = {
7725
7021
  /** The input fields for a shipping delivery method. */
7726
7022
  export type SubscriptionDeliveryMethodShippingInput = {
7727
7023
  /** The address to ship to. */
7728
- address: CustomerMailingAddressInput;
7024
+ address?: InputMaybe<CustomerMailingAddressInput>;
7025
+ /** The address to ship to. */
7026
+ shippingAddress?: InputMaybe<CustomerAddressInput>;
7729
7027
  };
7730
7028
 
7731
7029
  /** The selected shipping option on a subscription contract. */
@@ -7766,17 +7064,28 @@ export type SubscriptionDeliveryOptionsResultSuccess = {
7766
7064
  token: Scalars['String']['output'];
7767
7065
  };
7768
7066
 
7769
- /** Represents a Subscription Delivery Policy. */
7067
+ /** The delivery policy of a subscription. */
7770
7068
  export type SubscriptionDeliveryPolicy = {
7771
7069
  __typename?: 'SubscriptionDeliveryPolicy';
7772
7070
  /** The anchor dates for calculating delivery intervals. */
7773
- anchors: Array<SellingPlanAnchor>;
7071
+ anchors: Array<SubscriptionAnchor>;
7774
7072
  /** The type of interval associated with this schedule (e.g. Monthly, Weekly, etc). */
7775
- interval: SellingPlanInterval;
7073
+ interval: SubscriptionInterval;
7776
7074
  /** The number of intervals between deliveries. */
7777
- intervalCount: Scalars['Int']['output'];
7075
+ intervalCount?: Maybe<Count>;
7778
7076
  };
7779
7077
 
7078
+ /** Defines valid subscription intervals. */
7079
+ export type SubscriptionInterval =
7080
+ /** Represents a day interval. */
7081
+ | 'DAY'
7082
+ /** Represents a month interval. */
7083
+ | 'MONTH'
7084
+ /** Represents a week interval. */
7085
+ | 'WEEK'
7086
+ /** Represents a year interval. */
7087
+ | 'YEAR';
7088
+
7780
7089
  /** A line item in a subscription. */
7781
7090
  export type SubscriptionLine = {
7782
7091
  __typename?: 'SubscriptionLine';
@@ -7795,7 +7104,6 @@ export type SubscriptionLine = {
7795
7104
  /**
7796
7105
  * The URL of the product in the online store.
7797
7106
  * A value of `null` indicates that the product isn't published in the Online Store sales channel.
7798
- *
7799
7107
  */
7800
7108
  onlineStoreUrl?: Maybe<Scalars['URL']['output']>;
7801
7109
  /** The quantity of the unit selected for the subscription line. */
@@ -7814,27 +7122,21 @@ export type SubscriptionLine = {
7814
7122
  variantTitle?: Maybe<Scalars['String']['output']>;
7815
7123
  };
7816
7124
 
7817
- /**
7818
- * An auto-generated type for paginating through multiple SubscriptionLines.
7819
- *
7820
- */
7125
+ /** An auto-generated type for paginating through multiple SubscriptionLines. */
7821
7126
  export type SubscriptionLineConnection = {
7822
7127
  __typename?: 'SubscriptionLineConnection';
7823
- /** A list of edges. */
7128
+ /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
7824
7129
  edges: Array<SubscriptionLineEdge>;
7825
- /** A list of the nodes contained in SubscriptionLineEdge. */
7130
+ /** A list of nodes that are contained in SubscriptionLineEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
7826
7131
  nodes: Array<SubscriptionLine>;
7827
- /** Information to aid in pagination. */
7132
+ /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
7828
7133
  pageInfo: PageInfo;
7829
7134
  };
7830
7135
 
7831
- /**
7832
- * An auto-generated type which holds one SubscriptionLine and a cursor during pagination.
7833
- *
7834
- */
7136
+ /** An auto-generated type which holds one SubscriptionLine and a cursor during pagination. */
7835
7137
  export type SubscriptionLineEdge = {
7836
7138
  __typename?: 'SubscriptionLineEdge';
7837
- /** A cursor for use in pagination. */
7139
+ /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
7838
7140
  cursor: Scalars['String']['output'];
7839
7141
  /** The item at the end of SubscriptionLineEdge. */
7840
7142
  node: SubscriptionLine;
@@ -7873,7 +7175,6 @@ export type SubscriptionMailingAddress = {
7873
7175
  /**
7874
7176
  * The two-letter code for the country of the address.
7875
7177
  * For example, US.
7876
- *
7877
7178
  */
7878
7179
  countryCode?: Maybe<CountryCode>;
7879
7180
  /** The first name of the customer. */
@@ -7889,13 +7190,19 @@ export type SubscriptionMailingAddress = {
7889
7190
  /**
7890
7191
  * The alphanumeric code for the region.
7891
7192
  * For example, ON.
7892
- *
7893
7193
  */
7894
7194
  provinceCode?: Maybe<Scalars['String']['output']>;
7895
7195
  /** The zip or postal code of the address. */
7896
7196
  zip?: Maybe<Scalars['String']['output']>;
7897
7197
  };
7898
7198
 
7199
+ /** Represents an anchor specifying a day of the month. */
7200
+ export type SubscriptionMonthDayAnchor = {
7201
+ __typename?: 'SubscriptionMonthDayAnchor';
7202
+ /** Day of the month (1-31). */
7203
+ dayOfMonth: Scalars['Int']['output'];
7204
+ };
7205
+
7899
7206
  /** A pickup option to deliver a subscription contract. */
7900
7207
  export type SubscriptionPickupOption = {
7901
7208
  __typename?: 'SubscriptionPickupOption';
@@ -7909,10 +7216,7 @@ export type SubscriptionPickupOption = {
7909
7216
  phoneRequired: Scalars['Boolean']['output'];
7910
7217
  /** The pickup address where the customer will pickup the merchandise. */
7911
7218
  pickupAddress: PickupAddress;
7912
- /**
7913
- * The estimated amount of time it takes for the pickup to be ready. For example, "Usually ready in 24 hours".
7914
- *
7915
- */
7219
+ /** The estimated amount of time it takes for the pickup to be ready. For example, "Usually ready in 24 hours". */
7916
7220
  pickupTime: Scalars['String']['output'];
7917
7221
  /** The presentment title of the pickup option. */
7918
7222
  presentmentTitle?: Maybe<Scalars['String']['output']>;
@@ -7928,7 +7232,6 @@ export type SubscriptionPriceBreakdown = {
7928
7232
  /**
7929
7233
  * The sum of the prices for all line items after discounts.
7930
7234
  * If taxesIncluded is true, then the subtotal also includes tax.
7931
- *
7932
7235
  */
7933
7236
  subtotalPrice: MoneyV2;
7934
7237
  /** Whether taxes are included in the subtotal price. */
@@ -7936,7 +7239,6 @@ export type SubscriptionPriceBreakdown = {
7936
7239
  /**
7937
7240
  * The total amount discounted.
7938
7241
  * This includes both order and line level discounts.
7939
- *
7940
7242
  */
7941
7243
  totalDiscounts: MoneyV2;
7942
7244
  /** The total price. This includes taxes and discounts. */
@@ -7964,6 +7266,22 @@ export type SubscriptionShippingOption = {
7964
7266
  title: Scalars['String']['output'];
7965
7267
  };
7966
7268
 
7269
+ /** Represents an anchor specifying a day of the week. */
7270
+ export type SubscriptionWeekDayAnchor = {
7271
+ __typename?: 'SubscriptionWeekDayAnchor';
7272
+ /** Day of the week (1-7, where 1 is Monday). */
7273
+ dayOfWeek: Scalars['Int']['output'];
7274
+ };
7275
+
7276
+ /** Represents an anchor specifying a specific day and month of the year. */
7277
+ export type SubscriptionYearDayAnchor = {
7278
+ __typename?: 'SubscriptionYearDayAnchor';
7279
+ /** Day of the month (1-31). Specifies the exact day within the given month. */
7280
+ dayOfMonth: Scalars['Int']['output'];
7281
+ /** Month of the year (1-12). Specifies the month in which the day occurs. */
7282
+ month: Scalars['Int']['output'];
7283
+ };
7284
+
7967
7285
  /** The available tax exemptions for a customer. */
7968
7286
  export type TaxExemption =
7969
7287
  /** This customer is exempt from GST taxes for holding a valid exemption. The business customer should provide their GST number and account for the GST. */
@@ -8132,6 +7450,28 @@ export type TaxExemptionDetails = {
8132
7450
  type: TaxExemption;
8133
7451
  };
8134
7452
 
7453
+ /** A tax invoice on an order. */
7454
+ export type TaxInvoice = {
7455
+ __typename?: 'TaxInvoice';
7456
+ /** The time zone of the destination address of the tax invoice. */
7457
+ buyerTimeZone: Scalars['String']['output'];
7458
+ /** The datetime of when the tax invoice was created. */
7459
+ createdAt: Scalars['DateTime']['output'];
7460
+ /** The invoice number of the tax invoice. */
7461
+ invoiceNumber: Scalars['String']['output'];
7462
+ /** The current processing status of the tax invoice. */
7463
+ status: TaxInvoiceStatus;
7464
+ /** The url to download the tax invoice. */
7465
+ url: Scalars['URL']['output'];
7466
+ };
7467
+
7468
+ /** The current processing status of the tax invoices. */
7469
+ export type TaxInvoiceStatus =
7470
+ /** The tax invoice has been created. */
7471
+ | 'PROCESSED'
7472
+ /** The tax invoice is being created. */
7473
+ | 'PROCESSING';
7474
+
8135
7475
  /** The details about a single tax applied to the associated line item. */
8136
7476
  export type TaxLine = Node & {
8137
7477
  __typename?: 'TaxLine';
@@ -8644,10 +7984,7 @@ export type TaxRegionCode =
8644
7984
  /** Zimbabwe. */
8645
7985
  | 'ZW';
8646
7986
 
8647
- /**
8648
- * The events that chronicle resource activities available to the customer.
8649
- *
8650
- */
7987
+ /** The events that chronicle resource activities available to the customer. */
8651
7988
  export type TimelineEvent = Node & {
8652
7989
  __typename?: 'TimelineEvent';
8653
7990
  /** The date and time when the event occurred. */
@@ -8718,7 +8055,6 @@ export type TransactionTypeDetails = {
8718
8055
  /**
8719
8056
  * The custom data attached to a resource. Metafields can be sorted into namespaces and are
8720
8057
  * comprised of keys, values, and value types.
8721
- *
8722
8058
  */
8723
8059
  export type UiExtensionMetafield = Node & {
8724
8060
  __typename?: 'UiExtensionMetafield';
@@ -8735,7 +8071,6 @@ export type UiExtensionMetafield = Node & {
8735
8071
  /**
8736
8072
  * The type name of the metafield.
8737
8073
  * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).
8738
- *
8739
8074
  */
8740
8075
  type: Scalars['String']['output'];
8741
8076
  /** The value of a metafield. */
@@ -8755,28 +8090,16 @@ export type UiExtensionMetafieldFilterInput = {
8755
8090
  namespace: Scalars['String']['input'];
8756
8091
  };
8757
8092
 
8758
- /**
8759
- * A session token for a UI extension.
8760
- *
8761
- */
8093
+ /** A session token for a UI extension. */
8762
8094
  export type UiExtensionSessionToken = {
8763
8095
  __typename?: 'UiExtensionSessionToken';
8764
- /**
8765
- * The second count until the session token expires.
8766
- *
8767
- */
8096
+ /** The second count until the session token expires. */
8768
8097
  expiresIn: Scalars['Int']['output'];
8769
- /**
8770
- * The value of the UI extension session token.
8771
- *
8772
- */
8098
+ /** The value of the UI extension session token. */
8773
8099
  value: Scalars['String']['output'];
8774
8100
  };
8775
8101
 
8776
- /**
8777
- * The information about the container for unfulfilled digital line items (excluding gift cards).
8778
- *
8779
- */
8102
+ /** The information about the container for unfulfilled digital line items (excluding gift cards). */
8780
8103
  export type UnfulfilledDigitalLineItemContainer =
8781
8104
  UnfulfilledLineItemContainerCommonFields & {
8782
8105
  __typename?: 'UnfulfilledDigitalLineItemContainer';
@@ -8784,10 +8107,7 @@ export type UnfulfilledDigitalLineItemContainer =
8784
8107
  lineItems: LineItemContainerLineItemConnection;
8785
8108
  };
8786
8109
 
8787
- /**
8788
- * The information about the container for unfulfilled digital line items (excluding gift cards).
8789
- *
8790
- */
8110
+ /** The information about the container for unfulfilled digital line items (excluding gift cards). */
8791
8111
  export type UnfulfilledDigitalLineItemContainerLineItemsArgs = {
8792
8112
  after?: InputMaybe<Scalars['String']['input']>;
8793
8113
  before?: InputMaybe<Scalars['String']['input']>;
@@ -8796,10 +8116,7 @@ export type UnfulfilledDigitalLineItemContainerLineItemsArgs = {
8796
8116
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
8797
8117
  };
8798
8118
 
8799
- /**
8800
- * The information about the container for unfulfilled gift card type line items.
8801
- *
8802
- */
8119
+ /** The information about the container for unfulfilled gift card type line items. */
8803
8120
  export type UnfulfilledGiftCardLineItemContainer =
8804
8121
  UnfulfilledLineItemContainerCommonFields & {
8805
8122
  __typename?: 'UnfulfilledGiftCardLineItemContainer';
@@ -8807,10 +8124,7 @@ export type UnfulfilledGiftCardLineItemContainer =
8807
8124
  lineItems: LineItemContainerLineItemConnection;
8808
8125
  };
8809
8126
 
8810
- /**
8811
- * The information about the container for unfulfilled gift card type line items.
8812
- *
8813
- */
8127
+ /** The information about the container for unfulfilled gift card type line items. */
8814
8128
  export type UnfulfilledGiftCardLineItemContainerLineItemsArgs = {
8815
8129
  after?: InputMaybe<Scalars['String']['input']>;
8816
8130
  before?: InputMaybe<Scalars['String']['input']>;
@@ -8819,10 +8133,7 @@ export type UnfulfilledGiftCardLineItemContainerLineItemsArgs = {
8819
8133
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
8820
8134
  };
8821
8135
 
8822
- /**
8823
- * The information about the container for unfulfilled line items.
8824
- *
8825
- */
8136
+ /** The information about the container for unfulfilled line items. */
8826
8137
  export type UnfulfilledLineItemContainer =
8827
8138
  UnfulfilledLineItemContainerCommonFields & {
8828
8139
  __typename?: 'UnfulfilledLineItemContainer';
@@ -8834,10 +8145,7 @@ export type UnfulfilledLineItemContainer =
8834
8145
  state: Scalars['String']['output'];
8835
8146
  };
8836
8147
 
8837
- /**
8838
- * The information about the container for unfulfilled line items.
8839
- *
8840
- */
8148
+ /** The information about the container for unfulfilled line items. */
8841
8149
  export type UnfulfilledLineItemContainerLineItemsArgs = {
8842
8150
  after?: InputMaybe<Scalars['String']['input']>;
8843
8151
  before?: InputMaybe<Scalars['String']['input']>;
@@ -8861,10 +8169,7 @@ export type UnfulfilledLineItemContainerCommonFieldsLineItemsArgs = {
8861
8169
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
8862
8170
  };
8863
8171
 
8864
- /**
8865
- * The information about the container for unfulfilled physical type line items.
8866
- *
8867
- */
8172
+ /** The information about the container for unfulfilled physical type line items. */
8868
8173
  export type UnfulfilledPhysicalLineItemContainer =
8869
8174
  UnfulfilledLineItemContainerCommonFields & {
8870
8175
  __typename?: 'UnfulfilledPhysicalLineItemContainer';
@@ -8872,10 +8177,7 @@ export type UnfulfilledPhysicalLineItemContainer =
8872
8177
  lineItems: LineItemContainerLineItemConnection;
8873
8178
  };
8874
8179
 
8875
- /**
8876
- * The information about the container for unfulfilled physical type line items.
8877
- *
8878
- */
8180
+ /** The information about the container for unfulfilled physical type line items. */
8879
8181
  export type UnfulfilledPhysicalLineItemContainerLineItemsArgs = {
8880
8182
  after?: InputMaybe<Scalars['String']['input']>;
8881
8183
  before?: InputMaybe<Scalars['String']['input']>;
@@ -8884,39 +8186,21 @@ export type UnfulfilledPhysicalLineItemContainerLineItemsArgs = {
8884
8186
  reverse?: InputMaybe<Scalars['Boolean']['input']>;
8885
8187
  };
8886
8188
 
8887
- /**
8888
- * The unit price of the line component. For example, "$9.99 / 100ml".
8889
- *
8890
- */
8189
+ /** The unit price of the line component. For example, "$9.99 / 100ml". */
8891
8190
  export type UnitPrice = {
8892
8191
  __typename?: 'UnitPrice';
8893
- /**
8894
- * The unit measurement. For example, "$9.99 / 100ml".
8895
- *
8896
- */
8192
+ /** The unit measurement. For example, "$9.99 / 100ml". */
8897
8193
  measurement: UnitPriceMeasurement;
8898
- /**
8899
- * The unit price of the variant. For example, "$1 per xy" where price is "$1".
8900
- *
8901
- */
8194
+ /** The unit price of the variant. For example, "$1 per xy" where price is "$1". */
8902
8195
  price: MoneyV2;
8903
8196
  };
8904
8197
 
8905
- /**
8906
- * The unit price measurement of the line component. For example, "$9.99 / 100ml".
8907
- *
8908
- */
8198
+ /** The unit price measurement of the line component. For example, "$9.99 / 100ml". */
8909
8199
  export type UnitPriceMeasurement = {
8910
8200
  __typename?: 'UnitPriceMeasurement';
8911
- /**
8912
- * The reference unit for the unit price measurement. For example, "$9.99 / 100ml" where the reference unit is "ml".
8913
- *
8914
- */
8201
+ /** The reference unit for the unit price measurement. For example, "$9.99 / 100ml" where the reference unit is "ml". */
8915
8202
  referenceUnit: UnitPriceMeasurementUnit;
8916
- /**
8917
- * The reference value for the unit price measurement. For example, "$9.99 / 100ml" where the reference value is "100".
8918
- *
8919
- */
8203
+ /** The reference value for the unit price measurement. For example, "$9.99 / 100ml" where the reference value is "100". */
8920
8204
  referenceValue: Scalars['Int']['output'];
8921
8205
  };
8922
8206