@shopify/hydrogen-react 2022.7.1 → 2022.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.
- package/README.md +1 -1
- package/dist/dev/Metafield.cjs.map +1 -1
- package/dist/dev/Metafield.js.map +1 -1
- package/dist/dev/cart-hooks.cjs +0 -41
- package/dist/dev/cart-hooks.cjs.map +1 -1
- package/dist/dev/cart-hooks.js +2 -43
- package/dist/dev/cart-hooks.js.map +1 -1
- package/dist/dev/cart-queries.cjs +0 -102
- package/dist/dev/cart-queries.cjs.map +1 -1
- package/dist/dev/cart-queries.js +1 -103
- package/dist/dev/cart-queries.js.map +1 -1
- package/dist/dev/index.cjs +0 -3
- package/dist/dev/index.cjs.map +1 -1
- package/dist/dev/index.js +0 -3
- package/dist/dev/index.js.map +1 -1
- package/dist/dev/storefront-api-constants.cjs +1 -1
- package/dist/dev/storefront-api-constants.cjs.map +1 -1
- package/dist/dev/storefront-api-constants.js +1 -1
- package/dist/dev/storefront-api-constants.js.map +1 -1
- package/dist/dev/useCartActions.cjs.map +1 -1
- package/dist/dev/useCartActions.js.map +1 -1
- package/dist/prod/Metafield.cjs.map +1 -1
- package/dist/prod/Metafield.js.map +1 -1
- package/dist/prod/cart-hooks.cjs +0 -41
- package/dist/prod/cart-hooks.cjs.map +1 -1
- package/dist/prod/cart-hooks.js +2 -43
- package/dist/prod/cart-hooks.js.map +1 -1
- package/dist/prod/cart-queries.cjs +0 -102
- package/dist/prod/cart-queries.cjs.map +1 -1
- package/dist/prod/cart-queries.js +1 -103
- package/dist/prod/cart-queries.js.map +1 -1
- package/dist/prod/index.cjs +0 -3
- package/dist/prod/index.cjs.map +1 -1
- package/dist/prod/index.js +0 -3
- package/dist/prod/index.js.map +1 -1
- package/dist/prod/storefront-api-constants.cjs +1 -1
- package/dist/prod/storefront-api-constants.cjs.map +1 -1
- package/dist/prod/storefront-api-constants.js +1 -1
- package/dist/prod/storefront-api-constants.js.map +1 -1
- package/dist/prod/useCartActions.cjs.map +1 -1
- package/dist/prod/useCartActions.js.map +1 -1
- package/dist/types/index.d.cts +0 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/storefront-api-constants.d.ts +1 -1
- package/dist/types/storefront-api-types.d.ts +278 -73
- package/dist/types/useCartActions.d.ts +1 -1
- package/dist/umd/hydrogen-react.dev.js +252 -393
- package/dist/umd/hydrogen-react.dev.js.map +1 -1
- package/dist/umd/hydrogen-react.prod.js +57 -157
- package/dist/umd/hydrogen-react.prod.js.map +1 -1
- package/package.json +2 -1
- package/storefront.schema.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* THIS FILE IS AUTO-GENERATED, DO NOT EDIT
|
|
3
|
-
* Based on Storefront API 2022-
|
|
3
|
+
* Based on Storefront API 2022-10
|
|
4
4
|
* If changes need to happen to the types defined in this file, then generally the Storefront API needs to update, and then you can run `yarn graphql-types`
|
|
5
5
|
* Except custom Scalars, which are defined in the `codegen.yml` file
|
|
6
6
|
*/
|
|
@@ -21,12 +21,13 @@ export type Scalars = {
|
|
|
21
21
|
Boolean: boolean;
|
|
22
22
|
Int: number;
|
|
23
23
|
Float: number;
|
|
24
|
+
Color: string;
|
|
24
25
|
DateTime: string;
|
|
25
26
|
Decimal: string;
|
|
26
27
|
HTML: string;
|
|
27
28
|
JSON: unknown;
|
|
28
|
-
Money: string;
|
|
29
29
|
URL: string;
|
|
30
|
+
UnsignedInt64: string;
|
|
30
31
|
};
|
|
31
32
|
|
|
32
33
|
/**
|
|
@@ -47,19 +48,19 @@ export type ApiVersion = {
|
|
|
47
48
|
/** Details about the gift card used on the checkout. */
|
|
48
49
|
export type AppliedGiftCard = Node & {
|
|
49
50
|
__typename?: 'AppliedGiftCard';
|
|
51
|
+
/** The amount that was taken from the gift card by applying it. */
|
|
52
|
+
amountUsed: MoneyV2;
|
|
50
53
|
/**
|
|
51
54
|
* The amount that was taken from the gift card by applying it.
|
|
52
|
-
* @deprecated Use `
|
|
55
|
+
* @deprecated Use `amountUsed` instead.
|
|
53
56
|
*/
|
|
54
|
-
amountUsed: Scalars['Money'];
|
|
55
|
-
/** The amount that was taken from the gift card by applying it. */
|
|
56
57
|
amountUsedV2: MoneyV2;
|
|
58
|
+
/** The amount left on the gift card. */
|
|
59
|
+
balance: MoneyV2;
|
|
57
60
|
/**
|
|
58
61
|
* The amount left on the gift card.
|
|
59
|
-
* @deprecated Use `
|
|
62
|
+
* @deprecated Use `balance` instead.
|
|
60
63
|
*/
|
|
61
|
-
balance: Scalars['Money'];
|
|
62
|
-
/** The amount left on the gift card. */
|
|
63
64
|
balanceV2: MoneyV2;
|
|
64
65
|
/** A globally-unique identifier. */
|
|
65
66
|
id: Scalars['ID'];
|
|
@@ -363,6 +364,50 @@ export type BlogSortKeys =
|
|
|
363
364
|
/** Sort by the `title` value. */
|
|
364
365
|
| 'TITLE';
|
|
365
366
|
|
|
367
|
+
/**
|
|
368
|
+
* The store's branding configuration.
|
|
369
|
+
*
|
|
370
|
+
*/
|
|
371
|
+
export type Brand = {
|
|
372
|
+
__typename?: 'Brand';
|
|
373
|
+
/** The colors of the store's brand. */
|
|
374
|
+
colors: BrandColors;
|
|
375
|
+
/** The store's cover image. */
|
|
376
|
+
coverImage?: Maybe<MediaImage>;
|
|
377
|
+
/** The store's default logo. */
|
|
378
|
+
logo?: Maybe<MediaImage>;
|
|
379
|
+
/** The store's short description. */
|
|
380
|
+
shortDescription?: Maybe<Scalars['String']>;
|
|
381
|
+
/** The store's slogan. */
|
|
382
|
+
slogan?: Maybe<Scalars['String']>;
|
|
383
|
+
/** The store's preferred logo for square UI elements. */
|
|
384
|
+
squareLogo?: Maybe<MediaImage>;
|
|
385
|
+
};
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* A group of related colors for the shop's brand.
|
|
389
|
+
*
|
|
390
|
+
*/
|
|
391
|
+
export type BrandColorGroup = {
|
|
392
|
+
__typename?: 'BrandColorGroup';
|
|
393
|
+
/** The background color. */
|
|
394
|
+
background?: Maybe<Scalars['Color']>;
|
|
395
|
+
/** The foreground color. */
|
|
396
|
+
foreground?: Maybe<Scalars['Color']>;
|
|
397
|
+
};
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* The colors of the shop's brand.
|
|
401
|
+
*
|
|
402
|
+
*/
|
|
403
|
+
export type BrandColors = {
|
|
404
|
+
__typename?: 'BrandColors';
|
|
405
|
+
/** The shop's primary brand colors. */
|
|
406
|
+
primary: Array<BrandColorGroup>;
|
|
407
|
+
/** The shop's secondary brand colors. */
|
|
408
|
+
secondary: Array<BrandColorGroup>;
|
|
409
|
+
};
|
|
410
|
+
|
|
366
411
|
/** Card brand, such as Visa or Mastercard, which can be used for payments. */
|
|
367
412
|
export type CardBrand =
|
|
368
413
|
/** American Express. */
|
|
@@ -378,7 +423,13 @@ export type CardBrand =
|
|
|
378
423
|
/** Visa. */
|
|
379
424
|
| 'VISA';
|
|
380
425
|
|
|
381
|
-
/**
|
|
426
|
+
/**
|
|
427
|
+
* A cart represents the merchandise that a buyer intends to purchase,
|
|
428
|
+
* and the estimated cost associated with the cart. Learn how to
|
|
429
|
+
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
430
|
+
* during a customer's session.
|
|
431
|
+
*
|
|
432
|
+
*/
|
|
382
433
|
export type Cart = Node & {
|
|
383
434
|
__typename?: 'Cart';
|
|
384
435
|
/** An attribute associated with the cart. */
|
|
@@ -389,11 +440,15 @@ export type Cart = Node & {
|
|
|
389
440
|
buyerIdentity: CartBuyerIdentity;
|
|
390
441
|
/** The URL of the checkout for the cart. */
|
|
391
442
|
checkoutUrl: Scalars['URL'];
|
|
392
|
-
/** The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/
|
|
443
|
+
/** The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). */
|
|
393
444
|
cost: CartCost;
|
|
394
445
|
/** The date and time when the cart was created. */
|
|
395
446
|
createdAt: Scalars['DateTime'];
|
|
396
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* The delivery groups available for the cart, based on the buyer identity default
|
|
449
|
+
* delivery address preference or the default address of the logged-in customer.
|
|
450
|
+
*
|
|
451
|
+
*/
|
|
397
452
|
deliveryGroups: CartDeliveryGroupConnection;
|
|
398
453
|
/** The discounts that have been applied to the entire cart. */
|
|
399
454
|
discountAllocations: Array<
|
|
@@ -407,7 +462,11 @@ export type Cart = Node & {
|
|
|
407
462
|
*/
|
|
408
463
|
discountCodes: Array<CartDiscountCode>;
|
|
409
464
|
/**
|
|
410
|
-
* The estimated costs that the buyer will pay at checkout.
|
|
465
|
+
* The estimated costs that the buyer will pay at checkout.
|
|
466
|
+
* The estimated costs are subject to change and changes will be reflected at checkout.
|
|
467
|
+
* The `estimatedCost` field uses the `buyerIdentity` field to determine
|
|
468
|
+
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
|
|
469
|
+
*
|
|
411
470
|
* @deprecated Use `cost` instead.
|
|
412
471
|
*/
|
|
413
472
|
estimatedCost: CartEstimatedCost;
|
|
@@ -423,12 +482,24 @@ export type Cart = Node & {
|
|
|
423
482
|
updatedAt: Scalars['DateTime'];
|
|
424
483
|
};
|
|
425
484
|
|
|
426
|
-
/**
|
|
485
|
+
/**
|
|
486
|
+
* A cart represents the merchandise that a buyer intends to purchase,
|
|
487
|
+
* and the estimated cost associated with the cart. Learn how to
|
|
488
|
+
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
489
|
+
* during a customer's session.
|
|
490
|
+
*
|
|
491
|
+
*/
|
|
427
492
|
export type CartAttributeArgs = {
|
|
428
493
|
key: Scalars['String'];
|
|
429
494
|
};
|
|
430
495
|
|
|
431
|
-
/**
|
|
496
|
+
/**
|
|
497
|
+
* A cart represents the merchandise that a buyer intends to purchase,
|
|
498
|
+
* and the estimated cost associated with the cart. Learn how to
|
|
499
|
+
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
500
|
+
* during a customer's session.
|
|
501
|
+
*
|
|
502
|
+
*/
|
|
432
503
|
export type CartDeliveryGroupsArgs = {
|
|
433
504
|
after?: InputMaybe<Scalars['String']>;
|
|
434
505
|
before?: InputMaybe<Scalars['String']>;
|
|
@@ -437,7 +508,13 @@ export type CartDeliveryGroupsArgs = {
|
|
|
437
508
|
reverse?: InputMaybe<Scalars['Boolean']>;
|
|
438
509
|
};
|
|
439
510
|
|
|
440
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* A cart represents the merchandise that a buyer intends to purchase,
|
|
513
|
+
* and the estimated cost associated with the cart. Learn how to
|
|
514
|
+
* [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
515
|
+
* during a customer's session.
|
|
516
|
+
*
|
|
517
|
+
*/
|
|
441
518
|
export type CartLinesArgs = {
|
|
442
519
|
after?: InputMaybe<Scalars['String']>;
|
|
443
520
|
before?: InputMaybe<Scalars['String']>;
|
|
@@ -471,6 +548,13 @@ export type CartBuyerIdentity = {
|
|
|
471
548
|
countryCode?: Maybe<CountryCode>;
|
|
472
549
|
/** The customer account associated with the cart. */
|
|
473
550
|
customer?: Maybe<Customer>;
|
|
551
|
+
/**
|
|
552
|
+
* An ordered set of delivery addresses tied to the buyer that is interacting with the cart.
|
|
553
|
+
* The rank of the preferences is determined by the order of the addresses in the array. Preferences
|
|
554
|
+
* can be used to populate relevant fields in the checkout flow.
|
|
555
|
+
*
|
|
556
|
+
*/
|
|
557
|
+
deliveryAddressPreferences: Array<DeliveryAddress>;
|
|
474
558
|
/** The email address of the buyer that is interacting with the cart. */
|
|
475
559
|
email?: Maybe<Scalars['String']>;
|
|
476
560
|
/** The phone number of the buyer that is interacting with the cart. */
|
|
@@ -480,7 +564,7 @@ export type CartBuyerIdentity = {
|
|
|
480
564
|
/**
|
|
481
565
|
* Specifies the input fields to update the buyer information associated with a cart.
|
|
482
566
|
* Buyer identity is used to determine
|
|
483
|
-
* [international pricing](https://shopify.dev/
|
|
567
|
+
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
484
568
|
* and should match the customer's shipping address.
|
|
485
569
|
*
|
|
486
570
|
*/
|
|
@@ -489,6 +573,13 @@ export type CartBuyerIdentityInput = {
|
|
|
489
573
|
countryCode?: InputMaybe<CountryCode>;
|
|
490
574
|
/** The access token used to identify the customer associated with the cart. */
|
|
491
575
|
customerAccessToken?: InputMaybe<Scalars['String']>;
|
|
576
|
+
/**
|
|
577
|
+
* An ordered set of delivery addresses tied to the buyer that is interacting with the cart.
|
|
578
|
+
* The rank of the preferences is determined by the order of the addresses in the array. Preferences
|
|
579
|
+
* can be used to populate relevant fields in the checkout flow.
|
|
580
|
+
*
|
|
581
|
+
*/
|
|
582
|
+
deliveryAddressPreferences?: InputMaybe<Array<DeliveryAddressInput>>;
|
|
492
583
|
/** The email address of the buyer that is interacting with the cart. */
|
|
493
584
|
email?: InputMaybe<Scalars['String']>;
|
|
494
585
|
/** The phone number of the buyer that is interacting with the cart. */
|
|
@@ -515,8 +606,8 @@ export type CartCodeDiscountAllocation = CartDiscountAllocation & {
|
|
|
515
606
|
|
|
516
607
|
/**
|
|
517
608
|
* The costs that the buyer will pay at checkout.
|
|
518
|
-
*
|
|
519
|
-
* [international pricing](https://shopify.dev/
|
|
609
|
+
* The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine
|
|
610
|
+
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
|
|
520
611
|
*
|
|
521
612
|
*/
|
|
522
613
|
export type CartCost = {
|
|
@@ -570,6 +661,8 @@ export type CartDeliveryGroup = {
|
|
|
570
661
|
deliveryOptions: Array<CartDeliveryOption>;
|
|
571
662
|
/** The ID for the delivery group. */
|
|
572
663
|
id: Scalars['ID'];
|
|
664
|
+
/** The selected delivery option for the delivery group. */
|
|
665
|
+
selectedDeliveryOption?: Maybe<CartDeliveryOption>;
|
|
573
666
|
};
|
|
574
667
|
|
|
575
668
|
/** Information about the options available for one or more line items to be delivered to a specific address. */
|
|
@@ -618,6 +711,8 @@ export type CartDeliveryOption = {
|
|
|
618
711
|
description?: Maybe<Scalars['String']>;
|
|
619
712
|
/** The estimated cost for the delivery option. */
|
|
620
713
|
estimatedCost: MoneyV2;
|
|
714
|
+
/** The unique identifier of the delivery option. */
|
|
715
|
+
handle: Scalars['String'];
|
|
621
716
|
/** The title of the delivery option. */
|
|
622
717
|
title?: Maybe<Scalars['String']>;
|
|
623
718
|
};
|
|
@@ -661,8 +756,10 @@ export type CartErrorCode =
|
|
|
661
756
|
|
|
662
757
|
/**
|
|
663
758
|
* The estimated costs that the buyer will pay at checkout.
|
|
664
|
-
*
|
|
665
|
-
* [
|
|
759
|
+
* The estimated cost uses
|
|
760
|
+
* [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity)
|
|
761
|
+
* to determine
|
|
762
|
+
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
|
|
666
763
|
*
|
|
667
764
|
*/
|
|
668
765
|
export type CartEstimatedCost = {
|
|
@@ -683,7 +780,12 @@ export type CartEstimatedCost = {
|
|
|
683
780
|
export type CartInput = {
|
|
684
781
|
/** An array of key-value pairs that contains additional information about the cart. */
|
|
685
782
|
attributes?: InputMaybe<Array<AttributeInput>>;
|
|
686
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* The customer associated with the cart. Used to determine [international pricing]
|
|
785
|
+
* (https://shopify.dev/custom-storefronts/internationalization/international-pricing).
|
|
786
|
+
* Buyer identity should match the customer's shipping address.
|
|
787
|
+
*
|
|
788
|
+
*/
|
|
687
789
|
buyerIdentity?: InputMaybe<CartBuyerIdentityInput>;
|
|
688
790
|
/**
|
|
689
791
|
* The case-insensitive discount codes that the customer added at checkout.
|
|
@@ -845,6 +947,26 @@ export type CartNoteUpdatePayload = {
|
|
|
845
947
|
userErrors: Array<CartUserError>;
|
|
846
948
|
};
|
|
847
949
|
|
|
950
|
+
/**
|
|
951
|
+
* The input fields for updating the selected delivery options for a delivery group.
|
|
952
|
+
*
|
|
953
|
+
*/
|
|
954
|
+
export type CartSelectedDeliveryOptionInput = {
|
|
955
|
+
/** The ID of the cart delivery group. */
|
|
956
|
+
deliveryGroupId: Scalars['ID'];
|
|
957
|
+
/** The handle of the selected delivery option. */
|
|
958
|
+
deliveryOptionHandle: Scalars['String'];
|
|
959
|
+
};
|
|
960
|
+
|
|
961
|
+
/** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */
|
|
962
|
+
export type CartSelectedDeliveryOptionsUpdatePayload = {
|
|
963
|
+
__typename?: 'CartSelectedDeliveryOptionsUpdatePayload';
|
|
964
|
+
/** The updated cart. */
|
|
965
|
+
cart?: Maybe<Cart>;
|
|
966
|
+
/** The list of errors that occurred from executing the mutation. */
|
|
967
|
+
userErrors: Array<CartUserError>;
|
|
968
|
+
};
|
|
969
|
+
|
|
848
970
|
/** Represents an error that happens during execution of a cart mutation. */
|
|
849
971
|
export type CartUserError = DisplayableError & {
|
|
850
972
|
__typename?: 'CartUserError';
|
|
@@ -894,12 +1016,12 @@ export type Checkout = Node & {
|
|
|
894
1016
|
order?: Maybe<Order>;
|
|
895
1017
|
/** The Order Status Page for this Checkout, null when checkout is not completed. */
|
|
896
1018
|
orderStatusUrl?: Maybe<Scalars['URL']>;
|
|
1019
|
+
/** The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards. */
|
|
1020
|
+
paymentDue: MoneyV2;
|
|
897
1021
|
/**
|
|
898
|
-
* The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.
|
|
899
|
-
* @deprecated Use `
|
|
1022
|
+
* The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards.
|
|
1023
|
+
* @deprecated Use `paymentDue` instead.
|
|
900
1024
|
*/
|
|
901
|
-
paymentDue: Scalars['Money'];
|
|
902
|
-
/** The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards. */
|
|
903
1025
|
paymentDueV2: MoneyV2;
|
|
904
1026
|
/**
|
|
905
1027
|
* Whether or not the Checkout is ready and can be completed. Checkouts may
|
|
@@ -920,12 +1042,12 @@ export type Checkout = Node & {
|
|
|
920
1042
|
shippingDiscountAllocations: Array<DiscountAllocation>;
|
|
921
1043
|
/** Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. */
|
|
922
1044
|
shippingLine?: Maybe<ShippingRate>;
|
|
1045
|
+
/** The price at checkout before shipping and taxes. */
|
|
1046
|
+
subtotalPrice: MoneyV2;
|
|
923
1047
|
/**
|
|
924
|
-
*
|
|
925
|
-
* @deprecated Use `
|
|
1048
|
+
* The price at checkout before duties, shipping, and taxes.
|
|
1049
|
+
* @deprecated Use `subtotalPrice` instead.
|
|
926
1050
|
*/
|
|
927
|
-
subtotalPrice: Scalars['Money'];
|
|
928
|
-
/** The price at checkout before duties, shipping, and taxes. */
|
|
929
1051
|
subtotalPriceV2: MoneyV2;
|
|
930
1052
|
/** Whether the checkout is tax exempt. */
|
|
931
1053
|
taxExempt: Scalars['Boolean'];
|
|
@@ -933,19 +1055,19 @@ export type Checkout = Node & {
|
|
|
933
1055
|
taxesIncluded: Scalars['Boolean'];
|
|
934
1056
|
/** The sum of all the duties applied to the line items in the checkout. */
|
|
935
1057
|
totalDuties?: Maybe<MoneyV2>;
|
|
1058
|
+
/** The sum of all the prices of all the items in the checkout, including taxes and duties. */
|
|
1059
|
+
totalPrice: MoneyV2;
|
|
936
1060
|
/**
|
|
937
|
-
* The sum of all the prices of all the items in the checkout, taxes and
|
|
938
|
-
* @deprecated Use `
|
|
1061
|
+
* The sum of all the prices of all the items in the checkout, including taxes and duties.
|
|
1062
|
+
* @deprecated Use `totalPrice` instead.
|
|
939
1063
|
*/
|
|
940
|
-
totalPrice: Scalars['Money'];
|
|
941
|
-
/** The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts. */
|
|
942
1064
|
totalPriceV2: MoneyV2;
|
|
1065
|
+
/** The sum of all the taxes applied to the line items and shipping lines in the checkout. */
|
|
1066
|
+
totalTax: MoneyV2;
|
|
943
1067
|
/**
|
|
944
1068
|
* The sum of all the taxes applied to the line items and shipping lines in the checkout.
|
|
945
|
-
* @deprecated Use `
|
|
1069
|
+
* @deprecated Use `totalTax` instead.
|
|
946
1070
|
*/
|
|
947
|
-
totalTax: Scalars['Money'];
|
|
948
|
-
/** The sum of all the taxes applied to the line items and shipping lines in the checkout. */
|
|
949
1071
|
totalTaxV2: MoneyV2;
|
|
950
1072
|
/** The date and time when the checkout was last updated. */
|
|
951
1073
|
updatedAt: Scalars['DateTime'];
|
|
@@ -2547,6 +2669,8 @@ export type Customer = HasMetafields & {
|
|
|
2547
2669
|
*
|
|
2548
2670
|
*/
|
|
2549
2671
|
metafields: Array<Maybe<Metafield>>;
|
|
2672
|
+
/** The number of orders that the customer has made at the store in their lifetime. */
|
|
2673
|
+
numberOfOrders: Scalars['UnsignedInt64'];
|
|
2550
2674
|
/** The orders associated with the customer. */
|
|
2551
2675
|
orders: OrderConnection;
|
|
2552
2676
|
/** The customer’s phone number. */
|
|
@@ -2915,6 +3039,18 @@ export type CustomerUserError = DisplayableError & {
|
|
|
2915
3039
|
message: Scalars['String'];
|
|
2916
3040
|
};
|
|
2917
3041
|
|
|
3042
|
+
/** A delivery address of the buyer that is interacting with the cart. */
|
|
3043
|
+
export type DeliveryAddress = MailingAddress;
|
|
3044
|
+
|
|
3045
|
+
/**
|
|
3046
|
+
* The input fields for delivery address preferences.
|
|
3047
|
+
*
|
|
3048
|
+
*/
|
|
3049
|
+
export type DeliveryAddressInput = {
|
|
3050
|
+
/** A delivery address preference of a buyer that is interacting with the cart. */
|
|
3051
|
+
deliveryAddress?: InputMaybe<MailingAddressInput>;
|
|
3052
|
+
};
|
|
3053
|
+
|
|
2918
3054
|
/** List of different delivery method types. */
|
|
2919
3055
|
export type DeliveryMethodType =
|
|
2920
3056
|
/** Local Delivery. */
|
|
@@ -3124,7 +3260,7 @@ export type Filter = {
|
|
|
3124
3260
|
* The type of data that the filter group represents.
|
|
3125
3261
|
*
|
|
3126
3262
|
* For more information, refer to [Filter products in a collection with the Storefront API]
|
|
3127
|
-
* (https://shopify.dev/
|
|
3263
|
+
* (https://shopify.dev/custom-storefronts/products-collections/filter-products).
|
|
3128
3264
|
*
|
|
3129
3265
|
*/
|
|
3130
3266
|
export type FilterType =
|
|
@@ -4130,6 +4266,8 @@ export type Metafield = Node & {
|
|
|
4130
4266
|
parentResource: MetafieldParentResource;
|
|
4131
4267
|
/** Returns a reference object if the metafield definition's type is a resource reference. */
|
|
4132
4268
|
reference?: Maybe<MetafieldReference>;
|
|
4269
|
+
/** A list of reference objects if the metafield's type is a resource reference list. */
|
|
4270
|
+
references?: Maybe<MetafieldReferenceConnection>;
|
|
4133
4271
|
/**
|
|
4134
4272
|
* The type name of the metafield.
|
|
4135
4273
|
* See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).
|
|
@@ -4142,6 +4280,18 @@ export type Metafield = Node & {
|
|
|
4142
4280
|
value: Scalars['String'];
|
|
4143
4281
|
};
|
|
4144
4282
|
|
|
4283
|
+
/**
|
|
4284
|
+
* Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are
|
|
4285
|
+
* comprised of keys, values, and value types.
|
|
4286
|
+
*
|
|
4287
|
+
*/
|
|
4288
|
+
export type MetafieldReferencesArgs = {
|
|
4289
|
+
after?: InputMaybe<Scalars['String']>;
|
|
4290
|
+
before?: InputMaybe<Scalars['String']>;
|
|
4291
|
+
first?: InputMaybe<Scalars['Int']>;
|
|
4292
|
+
last?: InputMaybe<Scalars['Int']>;
|
|
4293
|
+
};
|
|
4294
|
+
|
|
4145
4295
|
/**
|
|
4146
4296
|
* A filter used to view a subset of products in a collection matching a specific metafield value.
|
|
4147
4297
|
*
|
|
@@ -4178,6 +4328,7 @@ export type MetafieldParentResource =
|
|
|
4178
4328
|
*
|
|
4179
4329
|
*/
|
|
4180
4330
|
export type MetafieldReference =
|
|
4331
|
+
| Collection
|
|
4181
4332
|
| GenericFile
|
|
4182
4333
|
| MediaImage
|
|
4183
4334
|
| Page
|
|
@@ -4185,6 +4336,32 @@ export type MetafieldReference =
|
|
|
4185
4336
|
| ProductVariant
|
|
4186
4337
|
| Video;
|
|
4187
4338
|
|
|
4339
|
+
/**
|
|
4340
|
+
* An auto-generated type for paginating through multiple MetafieldReferences.
|
|
4341
|
+
*
|
|
4342
|
+
*/
|
|
4343
|
+
export type MetafieldReferenceConnection = {
|
|
4344
|
+
__typename?: 'MetafieldReferenceConnection';
|
|
4345
|
+
/** A list of edges. */
|
|
4346
|
+
edges: Array<MetafieldReferenceEdge>;
|
|
4347
|
+
/** A list of the nodes contained in MetafieldReferenceEdge. */
|
|
4348
|
+
nodes: Array<MetafieldReference>;
|
|
4349
|
+
/** Information to aid in pagination. */
|
|
4350
|
+
pageInfo: PageInfo;
|
|
4351
|
+
};
|
|
4352
|
+
|
|
4353
|
+
/**
|
|
4354
|
+
* An auto-generated type which holds one MetafieldReference and a cursor during pagination.
|
|
4355
|
+
*
|
|
4356
|
+
*/
|
|
4357
|
+
export type MetafieldReferenceEdge = {
|
|
4358
|
+
__typename?: 'MetafieldReferenceEdge';
|
|
4359
|
+
/** A cursor for use in pagination. */
|
|
4360
|
+
cursor: Scalars['String'];
|
|
4361
|
+
/** The item at the end of MetafieldReferenceEdge. */
|
|
4362
|
+
node: MetafieldReference;
|
|
4363
|
+
};
|
|
4364
|
+
|
|
4188
4365
|
/** Represents a Shopify hosted 3D model. */
|
|
4189
4366
|
export type Model3d = Media &
|
|
4190
4367
|
Node & {
|
|
@@ -4242,7 +4419,7 @@ export type Mutation = {
|
|
|
4242
4419
|
/**
|
|
4243
4420
|
* Updates customer information associated with a cart.
|
|
4244
4421
|
* Buyer identity is used to determine
|
|
4245
|
-
* [international pricing](https://shopify.dev/
|
|
4422
|
+
* [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing)
|
|
4246
4423
|
* and should match the customer's shipping address.
|
|
4247
4424
|
*
|
|
4248
4425
|
*/
|
|
@@ -4259,6 +4436,8 @@ export type Mutation = {
|
|
|
4259
4436
|
cartLinesUpdate?: Maybe<CartLinesUpdatePayload>;
|
|
4260
4437
|
/** Updates the note on the cart. */
|
|
4261
4438
|
cartNoteUpdate?: Maybe<CartNoteUpdatePayload>;
|
|
4439
|
+
/** Update the selected delivery options for a delivery group. */
|
|
4440
|
+
cartSelectedDeliveryOptionsUpdate?: Maybe<CartSelectedDeliveryOptionsUpdatePayload>;
|
|
4262
4441
|
/** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */
|
|
4263
4442
|
checkoutAttributesUpdateV2?: Maybe<CheckoutAttributesUpdateV2Payload>;
|
|
4264
4443
|
/** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */
|
|
@@ -4334,7 +4513,17 @@ export type Mutation = {
|
|
|
4334
4513
|
/** Updates the default address of an existing customer. */
|
|
4335
4514
|
customerDefaultAddressUpdate?: Maybe<CustomerDefaultAddressUpdatePayload>;
|
|
4336
4515
|
/**
|
|
4337
|
-
*
|
|
4516
|
+
* Sends a reset password email to the customer. The reset password
|
|
4517
|
+
* email contains a reset password URL and token that you can pass to
|
|
4518
|
+
* the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or
|
|
4519
|
+
* [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the
|
|
4520
|
+
* customer password.
|
|
4521
|
+
*
|
|
4522
|
+
* This mutation is throttled by IP. With authenticated access,
|
|
4523
|
+
* you can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP.
|
|
4524
|
+
*
|
|
4525
|
+
* Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this
|
|
4526
|
+
* mutation presents a security risk.
|
|
4338
4527
|
*
|
|
4339
4528
|
*/
|
|
4340
4529
|
customerRecover?: Maybe<CustomerRecoverPayload>;
|
|
@@ -4399,6 +4588,12 @@ export type MutationCartNoteUpdateArgs = {
|
|
|
4399
4588
|
note?: InputMaybe<Scalars['String']>;
|
|
4400
4589
|
};
|
|
4401
4590
|
|
|
4591
|
+
/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */
|
|
4592
|
+
export type MutationCartSelectedDeliveryOptionsUpdateArgs = {
|
|
4593
|
+
cartId: Scalars['ID'];
|
|
4594
|
+
selectedDeliveryOptions: Array<CartSelectedDeliveryOptionInput>;
|
|
4595
|
+
};
|
|
4596
|
+
|
|
4402
4597
|
/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */
|
|
4403
4598
|
export type MutationCheckoutAttributesUpdateV2Args = {
|
|
4404
4599
|
checkoutId: Scalars['ID'];
|
|
@@ -4680,42 +4875,42 @@ export type Order = HasMetafields &
|
|
|
4680
4875
|
shippingDiscountAllocations: Array<DiscountAllocation>;
|
|
4681
4876
|
/** The unique URL for the order's status page. */
|
|
4682
4877
|
statusUrl: Scalars['URL'];
|
|
4878
|
+
/** Price of the order before shipping and taxes. */
|
|
4879
|
+
subtotalPrice?: Maybe<MoneyV2>;
|
|
4683
4880
|
/**
|
|
4684
|
-
* Price of the order before shipping and taxes.
|
|
4685
|
-
* @deprecated Use `
|
|
4881
|
+
* Price of the order before duties, shipping and taxes.
|
|
4882
|
+
* @deprecated Use `subtotalPrice` instead.
|
|
4686
4883
|
*/
|
|
4687
|
-
subtotalPrice?: Maybe<Scalars['Money']>;
|
|
4688
|
-
/** Price of the order before duties, shipping and taxes. */
|
|
4689
4884
|
subtotalPriceV2?: Maybe<MoneyV2>;
|
|
4690
4885
|
/** List of the order’s successful fulfillments. */
|
|
4691
4886
|
successfulFulfillments?: Maybe<Array<Fulfillment>>;
|
|
4887
|
+
/** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */
|
|
4888
|
+
totalPrice: MoneyV2;
|
|
4692
4889
|
/**
|
|
4693
|
-
* The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).
|
|
4694
|
-
* @deprecated Use `
|
|
4890
|
+
* The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
|
|
4891
|
+
* @deprecated Use `totalPrice` instead.
|
|
4695
4892
|
*/
|
|
4696
|
-
totalPrice: Scalars['Money'];
|
|
4697
|
-
/** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */
|
|
4698
4893
|
totalPriceV2: MoneyV2;
|
|
4894
|
+
/** The total amount that has been refunded. */
|
|
4895
|
+
totalRefunded: MoneyV2;
|
|
4699
4896
|
/**
|
|
4700
4897
|
* The total amount that has been refunded.
|
|
4701
|
-
* @deprecated Use `
|
|
4898
|
+
* @deprecated Use `totalRefunded` instead.
|
|
4702
4899
|
*/
|
|
4703
|
-
totalRefunded: Scalars['Money'];
|
|
4704
|
-
/** The total amount that has been refunded. */
|
|
4705
4900
|
totalRefundedV2: MoneyV2;
|
|
4901
|
+
/** The total cost of shipping. */
|
|
4902
|
+
totalShippingPrice: MoneyV2;
|
|
4706
4903
|
/**
|
|
4707
4904
|
* The total cost of shipping.
|
|
4708
|
-
* @deprecated Use `
|
|
4905
|
+
* @deprecated Use `totalShippingPrice` instead.
|
|
4709
4906
|
*/
|
|
4710
|
-
totalShippingPrice: Scalars['Money'];
|
|
4711
|
-
/** The total cost of shipping. */
|
|
4712
4907
|
totalShippingPriceV2: MoneyV2;
|
|
4908
|
+
/** The total cost of taxes. */
|
|
4909
|
+
totalTax?: Maybe<MoneyV2>;
|
|
4713
4910
|
/**
|
|
4714
4911
|
* The total cost of taxes.
|
|
4715
|
-
* @deprecated Use `
|
|
4912
|
+
* @deprecated Use `totalTax` instead.
|
|
4716
4913
|
*/
|
|
4717
|
-
totalTax?: Maybe<Scalars['Money']>;
|
|
4718
|
-
/** The total cost of taxes. */
|
|
4719
4914
|
totalTaxV2?: Maybe<MoneyV2>;
|
|
4720
4915
|
};
|
|
4721
4916
|
|
|
@@ -4778,6 +4973,8 @@ export type OrderConnection = {
|
|
|
4778
4973
|
nodes: Array<Order>;
|
|
4779
4974
|
/** Information to aid in pagination. */
|
|
4780
4975
|
pageInfo: PageInfo;
|
|
4976
|
+
/** The total count of Orders. */
|
|
4977
|
+
totalCount: Scalars['UnsignedInt64'];
|
|
4781
4978
|
};
|
|
4782
4979
|
|
|
4783
4980
|
/**
|
|
@@ -4996,12 +5193,12 @@ export type PageSortKeys =
|
|
|
4996
5193
|
/** A payment applied to a checkout. */
|
|
4997
5194
|
export type Payment = Node & {
|
|
4998
5195
|
__typename?: 'Payment';
|
|
5196
|
+
/** The amount of the payment. */
|
|
5197
|
+
amount: MoneyV2;
|
|
4999
5198
|
/**
|
|
5000
5199
|
* The amount of the payment.
|
|
5001
|
-
* @deprecated Use `
|
|
5200
|
+
* @deprecated Use `amount` instead.
|
|
5002
5201
|
*/
|
|
5003
|
-
amount: Scalars['Money'];
|
|
5004
|
-
/** The amount of the payment. */
|
|
5005
5202
|
amountV2: MoneyV2;
|
|
5006
5203
|
/** The billing address for the payment. */
|
|
5007
5204
|
billingAddress?: Maybe<MailingAddress>;
|
|
@@ -5117,6 +5314,8 @@ export type Product = HasMetafields &
|
|
|
5117
5314
|
id: Scalars['ID'];
|
|
5118
5315
|
/** List of images associated with the product. */
|
|
5119
5316
|
images: ImageConnection;
|
|
5317
|
+
/** Whether the product is a gift card. */
|
|
5318
|
+
isGiftCard: Scalars['Boolean'];
|
|
5120
5319
|
/** The media associated with the product. */
|
|
5121
5320
|
media: MediaConnection;
|
|
5122
5321
|
/** Returns a metafield found by namespace and key. */
|
|
@@ -5432,12 +5631,12 @@ export type ProductVariant = HasMetafields &
|
|
|
5432
5631
|
availableForSale: Scalars['Boolean'];
|
|
5433
5632
|
/** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */
|
|
5434
5633
|
barcode?: Maybe<Scalars['String']>;
|
|
5634
|
+
/** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. */
|
|
5635
|
+
compareAtPrice?: Maybe<MoneyV2>;
|
|
5435
5636
|
/**
|
|
5436
|
-
* The compare at price of the variant. This can be used to mark a variant as on sale, when `
|
|
5437
|
-
* @deprecated Use `
|
|
5637
|
+
* The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`.
|
|
5638
|
+
* @deprecated Use `compareAtPrice` instead.
|
|
5438
5639
|
*/
|
|
5439
|
-
compareAtPrice?: Maybe<Scalars['Money']>;
|
|
5440
|
-
/** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. */
|
|
5441
5640
|
compareAtPriceV2?: Maybe<MoneyV2>;
|
|
5442
5641
|
/** Whether a product is out of stock but still available for purchase (used for backorders). */
|
|
5443
5642
|
currentlyNotInStock: Scalars['Boolean'];
|
|
@@ -5455,12 +5654,12 @@ export type ProductVariant = HasMetafields &
|
|
|
5455
5654
|
*
|
|
5456
5655
|
*/
|
|
5457
5656
|
metafields: Array<Maybe<Metafield>>;
|
|
5657
|
+
/** The product variant’s price. */
|
|
5658
|
+
price: MoneyV2;
|
|
5458
5659
|
/**
|
|
5459
5660
|
* The product variant’s price.
|
|
5460
|
-
* @deprecated Use `
|
|
5661
|
+
* @deprecated Use `price` instead.
|
|
5461
5662
|
*/
|
|
5462
|
-
price: Scalars['Money'];
|
|
5463
|
-
/** The product variant’s price. */
|
|
5464
5663
|
priceV2: MoneyV2;
|
|
5465
5664
|
/** The product object that the product variant belongs to. */
|
|
5466
5665
|
product: Product;
|
|
@@ -5574,7 +5773,11 @@ export type QueryRoot = {
|
|
|
5574
5773
|
blogByHandle?: Maybe<Blog>;
|
|
5575
5774
|
/** List of the shop's blogs. */
|
|
5576
5775
|
blogs: BlogConnection;
|
|
5577
|
-
/**
|
|
5776
|
+
/**
|
|
5777
|
+
* Retrieve a cart by its ID. For more information, refer to
|
|
5778
|
+
* [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage).
|
|
5779
|
+
*
|
|
5780
|
+
*/
|
|
5578
5781
|
cart?: Maybe<Cart>;
|
|
5579
5782
|
/** Fetch a specific `Collection` by one of its unique attributes. */
|
|
5580
5783
|
collection?: Maybe<Collection>;
|
|
@@ -6147,12 +6350,12 @@ export type ShippingRate = {
|
|
|
6147
6350
|
__typename?: 'ShippingRate';
|
|
6148
6351
|
/** Human-readable unique identifier for this shipping rate. */
|
|
6149
6352
|
handle: Scalars['String'];
|
|
6353
|
+
/** Price of this shipping rate. */
|
|
6354
|
+
price: MoneyV2;
|
|
6150
6355
|
/**
|
|
6151
6356
|
* Price of this shipping rate.
|
|
6152
|
-
* @deprecated Use `
|
|
6357
|
+
* @deprecated Use `price` instead.
|
|
6153
6358
|
*/
|
|
6154
|
-
price: Scalars['Money'];
|
|
6155
|
-
/** Price of this shipping rate. */
|
|
6156
6359
|
priceV2: MoneyV2;
|
|
6157
6360
|
/** Title of this shipping rate. */
|
|
6158
6361
|
title: Scalars['String'];
|
|
@@ -6162,6 +6365,8 @@ export type ShippingRate = {
|
|
|
6162
6365
|
export type Shop = HasMetafields &
|
|
6163
6366
|
Node & {
|
|
6164
6367
|
__typename?: 'Shop';
|
|
6368
|
+
/** The shop's branding configuration. */
|
|
6369
|
+
brand?: Maybe<Brand>;
|
|
6165
6370
|
/** A description of the shop. */
|
|
6166
6371
|
description?: Maybe<Scalars['String']>;
|
|
6167
6372
|
/** A globally-unique identifier. */
|
|
@@ -6331,12 +6536,12 @@ export type TokenizedPaymentInputV3 = {
|
|
|
6331
6536
|
/** An object representing exchange of money for a product or service. */
|
|
6332
6537
|
export type Transaction = {
|
|
6333
6538
|
__typename?: 'Transaction';
|
|
6539
|
+
/** The amount of money that the transaction was for. */
|
|
6540
|
+
amount: MoneyV2;
|
|
6334
6541
|
/**
|
|
6335
6542
|
* The amount of money that the transaction was for.
|
|
6336
|
-
* @deprecated Use `
|
|
6543
|
+
* @deprecated Use `amount` instead.
|
|
6337
6544
|
*/
|
|
6338
|
-
amount: Scalars['Money'];
|
|
6339
|
-
/** The amount of money that the transaction was for. */
|
|
6340
6545
|
amountV2: MoneyV2;
|
|
6341
6546
|
/** The kind of the transaction. */
|
|
6342
6547
|
kind: TransactionKind;
|