@swishapp/sdk 0.133.0 → 0.134.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/dist/ajax-api/ajax-api-client.d.ts +11 -0
- package/dist/customiser/index.d.ts +1 -0
- package/dist/customiser/mount.d.ts +13 -0
- package/dist/dom/create-placement.d.ts +2 -2
- package/dist/dom/page-type.d.ts +7 -0
- package/dist/elements/swish-save-element.d.ts +1 -1
- package/dist/events/event-bus.d.ts +1 -1
- package/dist/intents/intents.d.ts +62 -3
- package/dist/options/schemas.d.ts +60 -0
- package/dist/options/swish-options.d.ts +3 -0
- package/dist/options/types.d.ts +7 -0
- package/dist/state/index.d.ts +1 -0
- package/dist/storefront-api/load-product-handle.d.ts +11 -0
- package/dist/storefront-api/load-product-images.d.ts +1 -1
- package/dist/storefront-api/load-product.d.ts +2 -50
- package/dist/storefront-api/queries/fragments.d.ts +1 -1
- package/dist/storefront-api/queries/index.d.ts +3 -2
- package/dist/storefront-api/storefront-api-client.d.ts +11 -54
- package/dist/storefront-api/types/storefront.generated.d.ts +167 -149
- package/dist/storefront-api/types/storefront.types.d.ts +1334 -411
- package/dist/swish-ui/swish-ui.d.ts +10 -4
- package/dist/swish.d.ts +15 -2
- package/dist/swish.js +42 -29
- package/dist/types.d.ts +21 -3
- package/package.json +4 -4
|
@@ -75,8 +75,9 @@ export type Scalars = {
|
|
|
75
75
|
};
|
|
76
76
|
};
|
|
77
77
|
/**
|
|
78
|
-
* A version of the API
|
|
79
|
-
*
|
|
78
|
+
* A version of the Shopify API. Each version has a unique handle in date-based format (YYYY-MM) or `unstable` for the development version.
|
|
79
|
+
*
|
|
80
|
+
* Shopify guarantees supported versions are stable. Unsupported versions include unstable and release candidate versions. Use the [`publicApiVersions`](https://shopify.dev/docs/api/storefront/current/queries/publicApiVersions) query to retrieve all available versions. Learn more about [Shopify API versioning](https://shopify.dev/docs/api/usage/versioning).
|
|
80
81
|
*
|
|
81
82
|
*/
|
|
82
83
|
export type ApiVersion = {
|
|
@@ -144,7 +145,12 @@ export type AppliedGiftCard = Node & {
|
|
|
144
145
|
/** The amount that was applied to the checkout in its currency. */
|
|
145
146
|
presentmentAmountUsed: MoneyV2;
|
|
146
147
|
};
|
|
147
|
-
/**
|
|
148
|
+
/**
|
|
149
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
150
|
+
*
|
|
151
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
152
|
+
*
|
|
153
|
+
*/
|
|
148
154
|
export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable & {
|
|
149
155
|
__typename?: 'Article';
|
|
150
156
|
/**
|
|
@@ -192,7 +198,12 @@ export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable
|
|
|
192
198
|
/** URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null. */
|
|
193
199
|
trackingParameters?: Maybe<Scalars['String']['output']>;
|
|
194
200
|
};
|
|
195
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
203
|
+
*
|
|
204
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
205
|
+
*
|
|
206
|
+
*/
|
|
196
207
|
export type ArticleCommentsArgs = {
|
|
197
208
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
198
209
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -200,20 +211,40 @@ export type ArticleCommentsArgs = {
|
|
|
200
211
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
201
212
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
202
213
|
};
|
|
203
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
216
|
+
*
|
|
217
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
218
|
+
*
|
|
219
|
+
*/
|
|
204
220
|
export type ArticleContentArgs = {
|
|
205
221
|
truncateAt?: InputMaybe<Scalars['Int']['input']>;
|
|
206
222
|
};
|
|
207
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
225
|
+
*
|
|
226
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
227
|
+
*
|
|
228
|
+
*/
|
|
208
229
|
export type ArticleExcerptArgs = {
|
|
209
230
|
truncateAt?: InputMaybe<Scalars['Int']['input']>;
|
|
210
231
|
};
|
|
211
|
-
/**
|
|
232
|
+
/**
|
|
233
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
234
|
+
*
|
|
235
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
236
|
+
*
|
|
237
|
+
*/
|
|
212
238
|
export type ArticleMetafieldArgs = {
|
|
213
239
|
key: Scalars['String']['input'];
|
|
214
240
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
215
241
|
};
|
|
216
|
-
/**
|
|
242
|
+
/**
|
|
243
|
+
* A post that belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog). Each article includes content with optional HTML formatting, an excerpt for previews, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, and an associated [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image).
|
|
244
|
+
*
|
|
245
|
+
* Articles can be organized with tags and include [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) metadata. You can manage [comments](https://shopify.dev/docs/api/storefront/current/objects/Comment) when the blog's comment policy enables them.
|
|
246
|
+
*
|
|
247
|
+
*/
|
|
217
248
|
export type ArticleMetafieldsArgs = {
|
|
218
249
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
219
250
|
};
|
|
@@ -276,7 +307,12 @@ export declare enum ArticleSortKeys {
|
|
|
276
307
|
/** Sort by the `updated_at` value. */
|
|
277
308
|
UpdatedAt = "UPDATED_AT"
|
|
278
309
|
}
|
|
279
|
-
/**
|
|
310
|
+
/**
|
|
311
|
+
* A custom key-value pair for storing additional information on [carts](https://shopify.dev/docs/api/storefront/current/objects/Cart), [cart lines](https://shopify.dev/docs/api/storefront/current/objects/CartLine), [orders](https://shopify.dev/docs/api/storefront/current/objects/Order), and [order line items](https://shopify.dev/docs/api/storefront/current/objects/OrderLineItem). Common uses include gift wrapping requests, customer notes, and tracking whether a customer is a first-time buyer.
|
|
312
|
+
*
|
|
313
|
+
* Attributes set on a cart carry over to the resulting order after checkout. Use the [`cartAttributesUpdate`](https://shopify.dev/docs/api/storefront/current/mutations/cartAttributesUpdate) mutation to add or modify cart attributes. For a step-by-step guide, see [managing carts with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
314
|
+
*
|
|
315
|
+
*/
|
|
280
316
|
export type Attribute = {
|
|
281
317
|
__typename?: 'Attribute';
|
|
282
318
|
/**
|
|
@@ -290,7 +326,10 @@ export type Attribute = {
|
|
|
290
326
|
*/
|
|
291
327
|
value?: Maybe<Scalars['String']['output']>;
|
|
292
328
|
};
|
|
293
|
-
/**
|
|
329
|
+
/**
|
|
330
|
+
* A custom key-value pair that stores additional information on a [cart](https://shopify.dev/docs/api/storefront/current/objects/Cart) or [cart line](https://shopify.dev/docs/api/storefront/current/objects/CartLine). Attributes capture additional information like gift messages, special instructions, or custom order details. Learn more about [managing carts with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
331
|
+
*
|
|
332
|
+
*/
|
|
294
333
|
export type AttributeInput = {
|
|
295
334
|
/** Key or name of the attribute. */
|
|
296
335
|
key: Scalars['String']['input'];
|
|
@@ -298,7 +337,9 @@ export type AttributeInput = {
|
|
|
298
337
|
value: Scalars['String']['input'];
|
|
299
338
|
};
|
|
300
339
|
/**
|
|
301
|
-
*
|
|
340
|
+
* An [automatic discount](https://help.shopify.com/manual/discounts/discount-methods/automatic-discounts) applied to a cart or checkout without requiring a discount code. Implements the [`DiscountApplication`](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication) interface.
|
|
341
|
+
*
|
|
342
|
+
* Includes the discount's title, value, and allocation details that specify how the discount amount distributes across entitled line items or shipping lines.
|
|
302
343
|
*
|
|
303
344
|
*/
|
|
304
345
|
export type AutomaticDiscountApplication = DiscountApplication & {
|
|
@@ -376,7 +417,12 @@ export type BaseCartLineEdge = {
|
|
|
376
417
|
/** The item at the end of BaseCartLineEdge. */
|
|
377
418
|
node: BaseCartLine;
|
|
378
419
|
};
|
|
379
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* A blog container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects. Stores can have multiple blogs, for example to organize content by topic or purpose.
|
|
422
|
+
*
|
|
423
|
+
* Each blog provides access to its articles, contributing [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) objects, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information. You can retrieve articles individually [by handle](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articleByHandle) or as a [paginated list](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articles).
|
|
424
|
+
*
|
|
425
|
+
*/
|
|
380
426
|
export type Blog = HasMetafields & Node & OnlineStorePublishable & {
|
|
381
427
|
__typename?: 'Blog';
|
|
382
428
|
/** Find an article by its handle. */
|
|
@@ -403,11 +449,21 @@ export type Blog = HasMetafields & Node & OnlineStorePublishable & {
|
|
|
403
449
|
/** The blogs’s title. */
|
|
404
450
|
title: Scalars['String']['output'];
|
|
405
451
|
};
|
|
406
|
-
/**
|
|
452
|
+
/**
|
|
453
|
+
* A blog container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects. Stores can have multiple blogs, for example to organize content by topic or purpose.
|
|
454
|
+
*
|
|
455
|
+
* Each blog provides access to its articles, contributing [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) objects, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information. You can retrieve articles individually [by handle](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articleByHandle) or as a [paginated list](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articles).
|
|
456
|
+
*
|
|
457
|
+
*/
|
|
407
458
|
export type BlogArticleByHandleArgs = {
|
|
408
459
|
handle: Scalars['String']['input'];
|
|
409
460
|
};
|
|
410
|
-
/**
|
|
461
|
+
/**
|
|
462
|
+
* A blog container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects. Stores can have multiple blogs, for example to organize content by topic or purpose.
|
|
463
|
+
*
|
|
464
|
+
* Each blog provides access to its articles, contributing [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) objects, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information. You can retrieve articles individually [by handle](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articleByHandle) or as a [paginated list](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articles).
|
|
465
|
+
*
|
|
466
|
+
*/
|
|
411
467
|
export type BlogArticlesArgs = {
|
|
412
468
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
413
469
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -417,12 +473,22 @@ export type BlogArticlesArgs = {
|
|
|
417
473
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
418
474
|
sortKey?: InputMaybe<ArticleSortKeys>;
|
|
419
475
|
};
|
|
420
|
-
/**
|
|
476
|
+
/**
|
|
477
|
+
* A blog container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects. Stores can have multiple blogs, for example to organize content by topic or purpose.
|
|
478
|
+
*
|
|
479
|
+
* Each blog provides access to its articles, contributing [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) objects, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information. You can retrieve articles individually [by handle](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articleByHandle) or as a [paginated list](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articles).
|
|
480
|
+
*
|
|
481
|
+
*/
|
|
421
482
|
export type BlogMetafieldArgs = {
|
|
422
483
|
key: Scalars['String']['input'];
|
|
423
484
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
424
485
|
};
|
|
425
|
-
/**
|
|
486
|
+
/**
|
|
487
|
+
* A blog container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects. Stores can have multiple blogs, for example to organize content by topic or purpose.
|
|
488
|
+
*
|
|
489
|
+
* Each blog provides access to its articles, contributing [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) objects, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information. You can retrieve articles individually [by handle](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articleByHandle) or as a [paginated list](https://shopify.dev/docs/api/storefront/current/objects/Blog#field-Blog.fields.articles).
|
|
490
|
+
*
|
|
491
|
+
*/
|
|
426
492
|
export type BlogMetafieldsArgs = {
|
|
427
493
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
428
494
|
};
|
|
@@ -466,7 +532,7 @@ export declare enum BlogSortKeys {
|
|
|
466
532
|
Title = "TITLE"
|
|
467
533
|
}
|
|
468
534
|
/**
|
|
469
|
-
* The store's [branding configuration](https://help.shopify.com/
|
|
535
|
+
* The store's [branding configuration](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets), such as logos, colors, and slogan. Access this through the [`Shop`](https://shopify.dev/docs/api/storefront/current/objects/Shop#field-Shop.fields.brand) object to display consistent brand assets across your storefront.
|
|
470
536
|
*
|
|
471
537
|
*/
|
|
472
538
|
export type Brand = {
|
|
@@ -507,7 +573,9 @@ export type BrandColors = {
|
|
|
507
573
|
secondary: Array<BrandColorGroup>;
|
|
508
574
|
};
|
|
509
575
|
/**
|
|
510
|
-
*
|
|
576
|
+
* Identifies a B2B buyer for the [`@inContext`](https://shopify.dev/docs/storefronts/headless/bring-your-own-stack/b2b) directive. Pass this input to contextualize Storefront API queries with data like B2B-specific pricing, quantity rules, and quantity price breaks.
|
|
577
|
+
*
|
|
578
|
+
* For B2B customers with access to multiple company locations, include the [`companyLocationId`](https://shopify.dev/docs/api/storefront/latest/input-objects/BuyerInput#fields-companyLocationId) to specify which location they're purchasing for.
|
|
511
579
|
*
|
|
512
580
|
*/
|
|
513
581
|
export type BuyerInput = {
|
|
@@ -532,10 +600,11 @@ export declare enum CardBrand {
|
|
|
532
600
|
Visa = "VISA"
|
|
533
601
|
}
|
|
534
602
|
/**
|
|
535
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
603
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
604
|
+
*
|
|
605
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
606
|
+
*
|
|
607
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
539
608
|
*
|
|
540
609
|
*/
|
|
541
610
|
export type Cart = HasMetafields & Node & {
|
|
@@ -562,7 +631,10 @@ export type Cart = HasMetafields & Node & {
|
|
|
562
631
|
*
|
|
563
632
|
*/
|
|
564
633
|
deliveryGroups: CartDeliveryGroupConnection;
|
|
565
|
-
/**
|
|
634
|
+
/**
|
|
635
|
+
* The discounts that have been applied to the entire cart.
|
|
636
|
+
* @deprecated Use `cart.lines[].discountAllocations(lineLevelOnly: false)` and `cart.deliveryGroups[].discountAllocations` instead.
|
|
637
|
+
*/
|
|
566
638
|
discountAllocations: Array<CartDiscountAllocation>;
|
|
567
639
|
/** The case-insensitive discount codes that the customer added at checkout. */
|
|
568
640
|
discountCodes: Array<CartDiscountCode>;
|
|
@@ -587,20 +659,22 @@ export type Cart = HasMetafields & Node & {
|
|
|
587
659
|
updatedAt: Scalars['DateTime']['output'];
|
|
588
660
|
};
|
|
589
661
|
/**
|
|
590
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
*
|
|
662
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
663
|
+
*
|
|
664
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
665
|
+
*
|
|
666
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
594
667
|
*
|
|
595
668
|
*/
|
|
596
669
|
export type CartAttributeArgs = {
|
|
597
670
|
key: Scalars['String']['input'];
|
|
598
671
|
};
|
|
599
672
|
/**
|
|
600
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
673
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
674
|
+
*
|
|
675
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
676
|
+
*
|
|
677
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
604
678
|
*
|
|
605
679
|
*/
|
|
606
680
|
export type CartDeliveryGroupsArgs = {
|
|
@@ -612,10 +686,11 @@ export type CartDeliveryGroupsArgs = {
|
|
|
612
686
|
withCarrierRates?: InputMaybe<Scalars['Boolean']['input']>;
|
|
613
687
|
};
|
|
614
688
|
/**
|
|
615
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
616
|
-
*
|
|
617
|
-
*
|
|
618
|
-
*
|
|
689
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
690
|
+
*
|
|
691
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
692
|
+
*
|
|
693
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
619
694
|
*
|
|
620
695
|
*/
|
|
621
696
|
export type CartLinesArgs = {
|
|
@@ -626,10 +701,11 @@ export type CartLinesArgs = {
|
|
|
626
701
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
627
702
|
};
|
|
628
703
|
/**
|
|
629
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
630
|
-
*
|
|
631
|
-
*
|
|
632
|
-
*
|
|
704
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
705
|
+
*
|
|
706
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
707
|
+
*
|
|
708
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
633
709
|
*
|
|
634
710
|
*/
|
|
635
711
|
export type CartMetafieldArgs = {
|
|
@@ -637,10 +713,11 @@ export type CartMetafieldArgs = {
|
|
|
637
713
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
638
714
|
};
|
|
639
715
|
/**
|
|
640
|
-
* A cart represents the merchandise that a buyer intends to purchase,
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
716
|
+
* A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.
|
|
717
|
+
*
|
|
718
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase.
|
|
719
|
+
*
|
|
720
|
+
* Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
644
721
|
*
|
|
645
722
|
*/
|
|
646
723
|
export type CartMetafieldsArgs = {
|
|
@@ -668,10 +745,16 @@ export type CartAttributesUpdatePayload = {
|
|
|
668
745
|
/** A list of warnings that occurred during the mutation. */
|
|
669
746
|
warnings: Array<CartWarning>;
|
|
670
747
|
};
|
|
671
|
-
/**
|
|
748
|
+
/**
|
|
749
|
+
* A discount allocation [that applies automatically](https://help.shopify.com/manual/discounts/discount-methods/automatic-discounts) to a cart line when configured conditions are met. Unlike [`CartCodeDiscountAllocation`](https://shopify.dev/docs/api/storefront/current/objects/CartCodeDiscountAllocation), automatic discounts don't require customers to enter a code.
|
|
750
|
+
*
|
|
751
|
+
*/
|
|
672
752
|
export type CartAutomaticDiscountAllocation = CartDiscountAllocation & {
|
|
673
753
|
__typename?: 'CartAutomaticDiscountAllocation';
|
|
674
|
-
/**
|
|
754
|
+
/**
|
|
755
|
+
* The discount that have been applied on the cart line.
|
|
756
|
+
* @deprecated Use `sourceDiscountApplication` instead.
|
|
757
|
+
*/
|
|
675
758
|
discountApplication: CartDiscountApplication;
|
|
676
759
|
/** The discounted amount that has been applied to the cart line. */
|
|
677
760
|
discountedAmount: MoneyV2;
|
|
@@ -788,12 +871,18 @@ export type CartClonePayload = {
|
|
|
788
871
|
/** A list of warnings that occurred during the mutation. */
|
|
789
872
|
warnings: Array<CartWarning>;
|
|
790
873
|
};
|
|
791
|
-
/**
|
|
874
|
+
/**
|
|
875
|
+
* A discount allocation applied to a cart line when a customer enters a [discount code](https://help.shopify.com/manual/discounts/discount-methods/discount-codes).
|
|
876
|
+
*
|
|
877
|
+
*/
|
|
792
878
|
export type CartCodeDiscountAllocation = CartDiscountAllocation & {
|
|
793
879
|
__typename?: 'CartCodeDiscountAllocation';
|
|
794
880
|
/** The code used to apply the discount. */
|
|
795
881
|
code: Scalars['String']['output'];
|
|
796
|
-
/**
|
|
882
|
+
/**
|
|
883
|
+
* The discount that have been applied on the cart line.
|
|
884
|
+
* @deprecated Use `sourceDiscountApplication` instead.
|
|
885
|
+
*/
|
|
797
886
|
discountApplication: CartDiscountApplication;
|
|
798
887
|
/** The discounted amount that has been applied to the cart line. */
|
|
799
888
|
discountedAmount: MoneyV2;
|
|
@@ -841,9 +930,9 @@ export type CartCompletionSuccess = {
|
|
|
841
930
|
orderUrl: Scalars['URL']['output'];
|
|
842
931
|
};
|
|
843
932
|
/**
|
|
844
|
-
* The costs that
|
|
845
|
-
*
|
|
846
|
-
*
|
|
933
|
+
* The estimated costs that a buyer will pay at checkout. The `Cart` object's [`cost`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-Cart.fields.cost) field returns this. The costs are subject to change and changes will be reflected at checkout. Costs reflect [international pricing](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/markets/international-pricing) based on the buyer's context.
|
|
934
|
+
*
|
|
935
|
+
* Amounts include the subtotal before taxes and cart-level discounts, the checkout charge amount excluding deferred payments, and the total. The subtotal and total amounts each include a corresponding boolean field indicating whether the value is an estimate.
|
|
847
936
|
*
|
|
848
937
|
*/
|
|
849
938
|
export type CartCost = {
|
|
@@ -904,7 +993,10 @@ export type CartCreatePayload = {
|
|
|
904
993
|
/** The discounts automatically applied to the cart line based on prerequisites that have been met. */
|
|
905
994
|
export type CartCustomDiscountAllocation = CartDiscountAllocation & {
|
|
906
995
|
__typename?: 'CartCustomDiscountAllocation';
|
|
907
|
-
/**
|
|
996
|
+
/**
|
|
997
|
+
* The discount that have been applied on the cart line.
|
|
998
|
+
* @deprecated Use `sourceDiscountApplication` instead.
|
|
999
|
+
*/
|
|
908
1000
|
discountApplication: CartDiscountApplication;
|
|
909
1001
|
/** The discounted amount that has been applied to the cart line. */
|
|
910
1002
|
discountedAmount: MoneyV2;
|
|
@@ -1095,7 +1187,12 @@ export type CartDeliveryCoordinatesPreferenceInput = {
|
|
|
1095
1187
|
/** The geographic longitude for a given location. Coordinates are required in order to set pickUpHandle for pickup points. */
|
|
1096
1188
|
longitude: Scalars['Float']['input'];
|
|
1097
1189
|
};
|
|
1098
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* Groups cart line items that share the same delivery destination. Each group provides the available [`CartDeliveryOption`](https://shopify.dev/docs/api/storefront/current/objects/CartDeliveryOption) choices for that address, along with the customer's selected option.
|
|
1192
|
+
*
|
|
1193
|
+
* Access through the [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart) object's `deliveryGroups` field. Items are grouped by merchandise type (one-time purchase vs subscription), allowing different delivery methods for each.
|
|
1194
|
+
*
|
|
1195
|
+
*/
|
|
1099
1196
|
export type CartDeliveryGroup = {
|
|
1100
1197
|
__typename?: 'CartDeliveryGroup';
|
|
1101
1198
|
/** A list of cart lines for the delivery group. */
|
|
@@ -1111,7 +1208,12 @@ export type CartDeliveryGroup = {
|
|
|
1111
1208
|
/** The selected delivery option for the delivery group. */
|
|
1112
1209
|
selectedDeliveryOption?: Maybe<CartDeliveryOption>;
|
|
1113
1210
|
};
|
|
1114
|
-
/**
|
|
1211
|
+
/**
|
|
1212
|
+
* Groups cart line items that share the same delivery destination. Each group provides the available [`CartDeliveryOption`](https://shopify.dev/docs/api/storefront/current/objects/CartDeliveryOption) choices for that address, along with the customer's selected option.
|
|
1213
|
+
*
|
|
1214
|
+
* Access through the [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart) object's `deliveryGroups` field. Items are grouped by merchandise type (one-time purchase vs subscription), allowing different delivery methods for each.
|
|
1215
|
+
*
|
|
1216
|
+
*/
|
|
1115
1217
|
export type CartDeliveryGroupCartLinesArgs = {
|
|
1116
1218
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
1117
1219
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -1166,7 +1268,12 @@ export type CartDeliveryInput = {
|
|
|
1166
1268
|
*/
|
|
1167
1269
|
addresses?: InputMaybe<Array<CartSelectableAddressInput>>;
|
|
1168
1270
|
};
|
|
1169
|
-
/**
|
|
1271
|
+
/**
|
|
1272
|
+
* A shipping or delivery choice available to customers during checkout. Each option includes a title, estimated cost, and delivery method type such as shipping or local pickup.
|
|
1273
|
+
*
|
|
1274
|
+
* Returned by the [`CartDeliveryGroup`](https://shopify.dev/docs/api/storefront/current/objects/CartDeliveryGroup) object's [`deliveryOptions`](https://shopify.dev/docs/api/storefront/current/objects/CartDeliveryGroup#field-CartDeliveryGroup.fields.deliveryOptions) field and [`selectedDeliveryOption`](https://shopify.dev/docs/api/storefront/current/objects/CartDeliveryGroup#field-CartDeliveryGroup.fields.selectedDeliveryOption) field.
|
|
1275
|
+
*
|
|
1276
|
+
*/
|
|
1170
1277
|
export type CartDeliveryOption = {
|
|
1171
1278
|
__typename?: 'CartDeliveryOption';
|
|
1172
1279
|
/** The code of the delivery option. */
|
|
@@ -1232,9 +1339,17 @@ export type CartDirectPaymentMethodInput = {
|
|
|
1232
1339
|
/** The session ID for the direct payment method used to create the payment. */
|
|
1233
1340
|
sessionId: Scalars['String']['input'];
|
|
1234
1341
|
};
|
|
1235
|
-
/**
|
|
1342
|
+
/**
|
|
1343
|
+
* A common interface for querying discount allocations regardless of how the discount was applied ([automatic](https://help.shopify.com/manual/discounts/discount-methods/automatic-discounts), [code](https://help.shopify.com/manual/discounts/discount-methods/discount-codes), or custom). Each implementation represents a different discount source.
|
|
1344
|
+
*
|
|
1345
|
+
* Tracks how a discount distributes across [cart lines](https://shopify.dev/docs/api/storefront/current/objects/CartLine). Each allocation includes the [`CartDiscountApplication`](https://shopify.dev/docs/api/storefront/current/objects/CartDiscountApplication) details, the discounted amount, and whether the discount targets line items or shipping.
|
|
1346
|
+
*
|
|
1347
|
+
*/
|
|
1236
1348
|
export type CartDiscountAllocation = {
|
|
1237
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* The discount that have been applied on the cart line.
|
|
1351
|
+
* @deprecated Use `sourceDiscountApplication` instead.
|
|
1352
|
+
*/
|
|
1238
1353
|
discountApplication: CartDiscountApplication;
|
|
1239
1354
|
/** The discounted amount that has been applied to the cart line. */
|
|
1240
1355
|
discountedAmount: MoneyV2;
|
|
@@ -1242,8 +1357,10 @@ export type CartDiscountAllocation = {
|
|
|
1242
1357
|
targetType: DiscountApplicationTargetType;
|
|
1243
1358
|
};
|
|
1244
1359
|
/**
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1360
|
+
* Captures the intent of a discount source at the time it was applied to a cart. This includes the discount value, how it's allocated across entitled items, and which line types it targets.
|
|
1361
|
+
*
|
|
1362
|
+
* The actual discounted amounts on specific cart lines are represented by [`CartDiscountAllocation`](https://shopify.dev/docs/api/storefront/current/interfaces/CartDiscountAllocation) objects, which reference this application.
|
|
1363
|
+
*
|
|
1247
1364
|
*/
|
|
1248
1365
|
export type CartDiscountApplication = {
|
|
1249
1366
|
__typename?: 'CartDiscountApplication';
|
|
@@ -1256,7 +1373,12 @@ export type CartDiscountApplication = {
|
|
|
1256
1373
|
/** The value of the discount application. */
|
|
1257
1374
|
value: PricingValue;
|
|
1258
1375
|
};
|
|
1259
|
-
/**
|
|
1376
|
+
/**
|
|
1377
|
+
* A discount code applied to a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). Discount codes are case-insensitive and can be added using the [`cartDiscountCodesUpdate`](https://shopify.dev/docs/api/storefront/current/mutations/cartDiscountCodesUpdate) mutation.
|
|
1378
|
+
*
|
|
1379
|
+
* The [`applicable`](https://shopify.dev/docs/api/storefront/current/objects/CartDiscountCode#field-CartDiscountCode.fields.applicable) field indicates whether the code applies to the cart's current contents, which might change as items are added or removed.
|
|
1380
|
+
*
|
|
1381
|
+
*/
|
|
1260
1382
|
export type CartDiscountCode = {
|
|
1261
1383
|
__typename?: 'CartDiscountCode';
|
|
1262
1384
|
/** Whether the discount code is applicable to the cart's current contents. */
|
|
@@ -1274,7 +1396,10 @@ export type CartDiscountCodesUpdatePayload = {
|
|
|
1274
1396
|
/** A list of warnings that occurred during the mutation. */
|
|
1275
1397
|
warnings: Array<CartWarning>;
|
|
1276
1398
|
};
|
|
1277
|
-
/**
|
|
1399
|
+
/**
|
|
1400
|
+
* Error codes returned by [`CartUserError`](https://shopify.dev/docs/api/storefront/current/objects/CartUserError) during cart mutations. Covers validation failures for addresses, quantities, delivery options, merchandise lines, discount codes, and metafields.
|
|
1401
|
+
*
|
|
1402
|
+
*/
|
|
1278
1403
|
export declare enum CartErrorCode {
|
|
1279
1404
|
/** The specified address field contains emojis. */
|
|
1280
1405
|
AddressFieldContainsEmojis = "ADDRESS_FIELD_CONTAINS_EMOJIS",
|
|
@@ -1393,7 +1518,12 @@ export declare enum CartErrorCode {
|
|
|
1393
1518
|
/** The given zip code is unsupported. */
|
|
1394
1519
|
ZipCodeNotSupported = "ZIP_CODE_NOT_SUPPORTED"
|
|
1395
1520
|
}
|
|
1396
|
-
/**
|
|
1521
|
+
/**
|
|
1522
|
+
* The estimated costs that the buyer pays at checkout. Uses [`CartBuyerIdentity`](https://shopify.dev/docs/api/storefront/current/objects/CartBuyerIdentity) to determine [international pricing](https://shopify.dev/docs/custom-storefronts/internationalization/international-pricing).
|
|
1523
|
+
*
|
|
1524
|
+
* Includes the subtotal, total amount, duties, and taxes. The [`checkoutChargeAmount`](https://shopify.dev/docs/api/storefront/current/objects/CartEstimatedCost#field-CartEstimatedCost.fields.checkoutChargeAmount) field excludes deferred payments that are charged later, making it useful for displaying what the customer pays immediately.
|
|
1525
|
+
*
|
|
1526
|
+
*/
|
|
1397
1527
|
export type CartEstimatedCost = {
|
|
1398
1528
|
__typename?: 'CartEstimatedCost';
|
|
1399
1529
|
/** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`. */
|
|
@@ -1445,7 +1575,12 @@ export type CartGiftCardCodesUpdatePayload = {
|
|
|
1445
1575
|
/** A list of warnings that occurred during the mutation. */
|
|
1446
1576
|
warnings: Array<CartWarning>;
|
|
1447
1577
|
};
|
|
1448
|
-
/**
|
|
1578
|
+
/**
|
|
1579
|
+
* The input fields for creating a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). Used by the [`cartCreate`](https://shopify.dev/docs/api/storefront/current/mutations/cartCreate) mutation.
|
|
1580
|
+
*
|
|
1581
|
+
* Accepts merchandise lines, discount codes, gift card codes, and a note. You can also set custom attributes, metafields, buyer identity for international pricing, and delivery addresses.
|
|
1582
|
+
*
|
|
1583
|
+
*/
|
|
1449
1584
|
export type CartInput = {
|
|
1450
1585
|
/**
|
|
1451
1586
|
* An array of key-value pairs that contains additional information about the cart.
|
|
@@ -1704,7 +1839,11 @@ export type CartMetafieldDeletePayload = {
|
|
|
1704
1839
|
};
|
|
1705
1840
|
/** The input fields for a cart metafield value to set. */
|
|
1706
1841
|
export type CartMetafieldsSetInput = {
|
|
1707
|
-
/**
|
|
1842
|
+
/**
|
|
1843
|
+
* The key name of the cart metafield. This can either be a composite key (`namespace.key`) or a simple key
|
|
1844
|
+
* that relies on the default app-reserved namespace.
|
|
1845
|
+
*
|
|
1846
|
+
*/
|
|
1708
1847
|
key: Scalars['String']['input'];
|
|
1709
1848
|
/** The ID of the cart resource. */
|
|
1710
1849
|
ownerId: Scalars['ID']['input'];
|
|
@@ -1954,7 +2093,12 @@ export type CartWalletPaymentMethodInput = {
|
|
|
1954
2093
|
/** The payment method information for the Shop Pay wallet. */
|
|
1955
2094
|
shopPayWalletContent?: InputMaybe<ShopPayWalletContentInput>;
|
|
1956
2095
|
};
|
|
1957
|
-
/**
|
|
2096
|
+
/**
|
|
2097
|
+
* A non-blocking issue that occurred during a cart mutation. Unlike errors, warnings don't prevent the mutation from completing but indicate potential problems that may affect the buyer's experience.
|
|
2098
|
+
*
|
|
2099
|
+
* Each warning includes a code identifying the issue type, a human-readable message, and a target ID pointing to the affected resource.
|
|
2100
|
+
*
|
|
2101
|
+
*/
|
|
1958
2102
|
export type CartWarning = {
|
|
1959
2103
|
__typename?: 'CartWarning';
|
|
1960
2104
|
/** The code of the warning. */
|
|
@@ -2010,8 +2154,9 @@ export type CategoryFilter = {
|
|
|
2010
2154
|
id: Scalars['String']['input'];
|
|
2011
2155
|
};
|
|
2012
2156
|
/**
|
|
2013
|
-
* A
|
|
2014
|
-
*
|
|
2157
|
+
* A group of products [organized by a merchant](https://help.shopify.com/manual/products/collections) to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.
|
|
2158
|
+
*
|
|
2159
|
+
* Query a collection's products with [filtering options](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) like availability, price range, vendor, and tags. Each collection includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, an optional [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image), and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
2015
2160
|
*
|
|
2016
2161
|
*/
|
|
2017
2162
|
export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackable & {
|
|
@@ -2048,16 +2193,18 @@ export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackab
|
|
|
2048
2193
|
updatedAt: Scalars['DateTime']['output'];
|
|
2049
2194
|
};
|
|
2050
2195
|
/**
|
|
2051
|
-
* A
|
|
2052
|
-
*
|
|
2196
|
+
* A group of products [organized by a merchant](https://help.shopify.com/manual/products/collections) to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.
|
|
2197
|
+
*
|
|
2198
|
+
* Query a collection's products with [filtering options](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) like availability, price range, vendor, and tags. Each collection includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, an optional [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image), and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
2053
2199
|
*
|
|
2054
2200
|
*/
|
|
2055
2201
|
export type CollectionDescriptionArgs = {
|
|
2056
2202
|
truncateAt?: InputMaybe<Scalars['Int']['input']>;
|
|
2057
2203
|
};
|
|
2058
2204
|
/**
|
|
2059
|
-
* A
|
|
2060
|
-
*
|
|
2205
|
+
* A group of products [organized by a merchant](https://help.shopify.com/manual/products/collections) to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.
|
|
2206
|
+
*
|
|
2207
|
+
* Query a collection's products with [filtering options](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) like availability, price range, vendor, and tags. Each collection includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, an optional [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image), and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
2061
2208
|
*
|
|
2062
2209
|
*/
|
|
2063
2210
|
export type CollectionMetafieldArgs = {
|
|
@@ -2065,16 +2212,18 @@ export type CollectionMetafieldArgs = {
|
|
|
2065
2212
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
2066
2213
|
};
|
|
2067
2214
|
/**
|
|
2068
|
-
* A
|
|
2069
|
-
*
|
|
2215
|
+
* A group of products [organized by a merchant](https://help.shopify.com/manual/products/collections) to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.
|
|
2216
|
+
*
|
|
2217
|
+
* Query a collection's products with [filtering options](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) like availability, price range, vendor, and tags. Each collection includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, an optional [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image), and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
2070
2218
|
*
|
|
2071
2219
|
*/
|
|
2072
2220
|
export type CollectionMetafieldsArgs = {
|
|
2073
2221
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
2074
2222
|
};
|
|
2075
2223
|
/**
|
|
2076
|
-
* A
|
|
2077
|
-
*
|
|
2224
|
+
* A group of products [organized by a merchant](https://help.shopify.com/manual/products/collections) to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.
|
|
2225
|
+
*
|
|
2226
|
+
* Query a collection's products with [filtering options](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) like availability, price range, vendor, and tags. Each collection includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, an optional [`Image`](https://shopify.dev/docs/api/storefront/current/objects/Image), and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
2078
2227
|
*
|
|
2079
2228
|
*/
|
|
2080
2229
|
export type CollectionProductsArgs = {
|
|
@@ -2175,7 +2324,12 @@ export type CommentEdge = {
|
|
|
2175
2324
|
/** The item at the end of CommentEdge. */
|
|
2176
2325
|
node: Comment;
|
|
2177
2326
|
};
|
|
2178
|
-
/**
|
|
2327
|
+
/**
|
|
2328
|
+
* A B2B organization that purchases from the shop. In the Storefront API, company information is accessed through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object on [`CartBuyerIdentity`](https://shopify.dev/docs/api/storefront/current/objects/CartBuyerIdentity), which provides the associated location and contact for the current purchasing context.
|
|
2329
|
+
*
|
|
2330
|
+
* You can store custom data using [metafields](https://shopify.dev/docs/apps/build/metafields).
|
|
2331
|
+
*
|
|
2332
|
+
*/
|
|
2179
2333
|
export type Company = HasMetafields & Node & {
|
|
2180
2334
|
__typename?: 'Company';
|
|
2181
2335
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify. */
|
|
@@ -2193,12 +2347,22 @@ export type Company = HasMetafields & Node & {
|
|
|
2193
2347
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified. */
|
|
2194
2348
|
updatedAt: Scalars['DateTime']['output'];
|
|
2195
2349
|
};
|
|
2196
|
-
/**
|
|
2350
|
+
/**
|
|
2351
|
+
* A B2B organization that purchases from the shop. In the Storefront API, company information is accessed through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object on [`CartBuyerIdentity`](https://shopify.dev/docs/api/storefront/current/objects/CartBuyerIdentity), which provides the associated location and contact for the current purchasing context.
|
|
2352
|
+
*
|
|
2353
|
+
* You can store custom data using [metafields](https://shopify.dev/docs/apps/build/metafields).
|
|
2354
|
+
*
|
|
2355
|
+
*/
|
|
2197
2356
|
export type CompanyMetafieldArgs = {
|
|
2198
2357
|
key: Scalars['String']['input'];
|
|
2199
2358
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
2200
2359
|
};
|
|
2201
|
-
/**
|
|
2360
|
+
/**
|
|
2361
|
+
* A B2B organization that purchases from the shop. In the Storefront API, company information is accessed through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object on [`CartBuyerIdentity`](https://shopify.dev/docs/api/storefront/current/objects/CartBuyerIdentity), which provides the associated location and contact for the current purchasing context.
|
|
2362
|
+
*
|
|
2363
|
+
* You can store custom data using [metafields](https://shopify.dev/docs/apps/build/metafields).
|
|
2364
|
+
*
|
|
2365
|
+
*/
|
|
2202
2366
|
export type CompanyMetafieldsArgs = {
|
|
2203
2367
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
2204
2368
|
};
|
|
@@ -2216,7 +2380,12 @@ export type CompanyContact = Node & {
|
|
|
2216
2380
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was last modified. */
|
|
2217
2381
|
updatedAt: Scalars['DateTime']['output'];
|
|
2218
2382
|
};
|
|
2219
|
-
/**
|
|
2383
|
+
/**
|
|
2384
|
+
* A branch or office of a [`Company`](https://shopify.dev/docs/api/storefront/current/objects/Company) where B2B customers can place orders. When a B2B customer selects a location after logging in, the Storefront API contextualizes product queries to return location-specific pricing and quantity rules.
|
|
2385
|
+
*
|
|
2386
|
+
* Access through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object, which associates the location with the buyer's [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart).
|
|
2387
|
+
*
|
|
2388
|
+
*/
|
|
2220
2389
|
export type CompanyLocation = HasMetafields & Node & {
|
|
2221
2390
|
__typename?: 'CompanyLocation';
|
|
2222
2391
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify. */
|
|
@@ -2236,12 +2405,22 @@ export type CompanyLocation = HasMetafields & Node & {
|
|
|
2236
2405
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified. */
|
|
2237
2406
|
updatedAt: Scalars['DateTime']['output'];
|
|
2238
2407
|
};
|
|
2239
|
-
/**
|
|
2408
|
+
/**
|
|
2409
|
+
* A branch or office of a [`Company`](https://shopify.dev/docs/api/storefront/current/objects/Company) where B2B customers can place orders. When a B2B customer selects a location after logging in, the Storefront API contextualizes product queries to return location-specific pricing and quantity rules.
|
|
2410
|
+
*
|
|
2411
|
+
* Access through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object, which associates the location with the buyer's [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart).
|
|
2412
|
+
*
|
|
2413
|
+
*/
|
|
2240
2414
|
export type CompanyLocationMetafieldArgs = {
|
|
2241
2415
|
key: Scalars['String']['input'];
|
|
2242
2416
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
2243
2417
|
};
|
|
2244
|
-
/**
|
|
2418
|
+
/**
|
|
2419
|
+
* A branch or office of a [`Company`](https://shopify.dev/docs/api/storefront/current/objects/Company) where B2B customers can place orders. When a B2B customer selects a location after logging in, the Storefront API contextualizes product queries to return location-specific pricing and quantity rules.
|
|
2420
|
+
*
|
|
2421
|
+
* Access through the [`PurchasingCompany`](https://shopify.dev/docs/api/storefront/current/objects/PurchasingCompany) object, which associates the location with the buyer's [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart).
|
|
2422
|
+
*
|
|
2423
|
+
*/
|
|
2245
2424
|
export type CompanyLocationMetafieldsArgs = {
|
|
2246
2425
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
2247
2426
|
};
|
|
@@ -2321,7 +2500,12 @@ export declare enum CountPrecision {
|
|
|
2321
2500
|
/** The count is exactly the value. */
|
|
2322
2501
|
Exact = "EXACT"
|
|
2323
2502
|
}
|
|
2324
|
-
/**
|
|
2503
|
+
/**
|
|
2504
|
+
* A country with localization settings for a storefront. Includes the country's currency, available languages, default language, and unit system (metric or imperial).
|
|
2505
|
+
*
|
|
2506
|
+
* Access countries through the [localization](https://shopify.dev/docs/api/storefront/current/queries/localization) query, which returns both the list of available countries and the currently active country. Use the [`@inContext`](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/in-context) directive to change the active country context.
|
|
2507
|
+
*
|
|
2508
|
+
*/
|
|
2325
2509
|
export type Country = {
|
|
2326
2510
|
__typename?: 'Country';
|
|
2327
2511
|
/** The languages available for the country. */
|
|
@@ -3203,7 +3387,14 @@ export declare enum CurrencyCode {
|
|
|
3203
3387
|
/** Zambian Kwacha (ZMW). */
|
|
3204
3388
|
Zmw = "ZMW"
|
|
3205
3389
|
}
|
|
3206
|
-
/**
|
|
3390
|
+
/**
|
|
3391
|
+
* A customer account with the shop. Includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) and marketing preferences for logged-in customers, so they don't have to provide these details at every checkout.
|
|
3392
|
+
*
|
|
3393
|
+
* Access the customer through the [`customer`](https://shopify.dev/docs/api/storefront/current/queries/customer) query using a customer access token obtained from the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation.
|
|
3394
|
+
*
|
|
3395
|
+
* The object implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface, enabling retrieval of [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
3396
|
+
*
|
|
3397
|
+
*/
|
|
3207
3398
|
export type Customer = HasMetafields & {
|
|
3208
3399
|
__typename?: 'Customer';
|
|
3209
3400
|
/** Indicates whether the customer has consented to be sent marketing material via email. */
|
|
@@ -3247,7 +3438,14 @@ export type Customer = HasMetafields & {
|
|
|
3247
3438
|
/** The date and time when the customer information was updated. */
|
|
3248
3439
|
updatedAt: Scalars['DateTime']['output'];
|
|
3249
3440
|
};
|
|
3250
|
-
/**
|
|
3441
|
+
/**
|
|
3442
|
+
* A customer account with the shop. Includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) and marketing preferences for logged-in customers, so they don't have to provide these details at every checkout.
|
|
3443
|
+
*
|
|
3444
|
+
* Access the customer through the [`customer`](https://shopify.dev/docs/api/storefront/current/queries/customer) query using a customer access token obtained from the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation.
|
|
3445
|
+
*
|
|
3446
|
+
* The object implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface, enabling retrieval of [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
3447
|
+
*
|
|
3448
|
+
*/
|
|
3251
3449
|
export type CustomerAddressesArgs = {
|
|
3252
3450
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
3253
3451
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -3255,16 +3453,37 @@ export type CustomerAddressesArgs = {
|
|
|
3255
3453
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
3256
3454
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
3257
3455
|
};
|
|
3258
|
-
/**
|
|
3456
|
+
/**
|
|
3457
|
+
* A customer account with the shop. Includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) and marketing preferences for logged-in customers, so they don't have to provide these details at every checkout.
|
|
3458
|
+
*
|
|
3459
|
+
* Access the customer through the [`customer`](https://shopify.dev/docs/api/storefront/current/queries/customer) query using a customer access token obtained from the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation.
|
|
3460
|
+
*
|
|
3461
|
+
* The object implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface, enabling retrieval of [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
3462
|
+
*
|
|
3463
|
+
*/
|
|
3259
3464
|
export type CustomerMetafieldArgs = {
|
|
3260
3465
|
key: Scalars['String']['input'];
|
|
3261
3466
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
3262
3467
|
};
|
|
3263
|
-
/**
|
|
3468
|
+
/**
|
|
3469
|
+
* A customer account with the shop. Includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) and marketing preferences for logged-in customers, so they don't have to provide these details at every checkout.
|
|
3470
|
+
*
|
|
3471
|
+
* Access the customer through the [`customer`](https://shopify.dev/docs/api/storefront/current/queries/customer) query using a customer access token obtained from the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation.
|
|
3472
|
+
*
|
|
3473
|
+
* The object implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface, enabling retrieval of [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
3474
|
+
*
|
|
3475
|
+
*/
|
|
3264
3476
|
export type CustomerMetafieldsArgs = {
|
|
3265
3477
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
3266
3478
|
};
|
|
3267
|
-
/**
|
|
3479
|
+
/**
|
|
3480
|
+
* A customer account with the shop. Includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) and marketing preferences for logged-in customers, so they don't have to provide these details at every checkout.
|
|
3481
|
+
*
|
|
3482
|
+
* Access the customer through the [`customer`](https://shopify.dev/docs/api/storefront/current/queries/customer) query using a customer access token obtained from the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation.
|
|
3483
|
+
*
|
|
3484
|
+
* The object implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface, enabling retrieval of [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
3485
|
+
*
|
|
3486
|
+
*/
|
|
3268
3487
|
export type CustomerOrdersArgs = {
|
|
3269
3488
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
3270
3489
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -3274,7 +3493,12 @@ export type CustomerOrdersArgs = {
|
|
|
3274
3493
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
3275
3494
|
sortKey?: InputMaybe<OrderSortKeys>;
|
|
3276
3495
|
};
|
|
3277
|
-
/**
|
|
3496
|
+
/**
|
|
3497
|
+
* A unique authentication token that identifies a logged-in customer and authorizes modifications to the [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) object. The token is required for customer-specific operations like updating profile information or managing addresses.
|
|
3498
|
+
*
|
|
3499
|
+
* Tokens have an expiration date and must be renewed using [`customerAccessTokenRenew`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenRenew) before they expire. Create tokens with [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) using legacy customer account authentication (email and password), or with [`customerAccessTokenCreateWithMultipass`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreateWithMultipass) for single sign-on flows.
|
|
3500
|
+
*
|
|
3501
|
+
*/
|
|
3278
3502
|
export type CustomerAccessToken = {
|
|
3279
3503
|
__typename?: 'CustomerAccessToken';
|
|
3280
3504
|
/** The customer’s access token. */
|
|
@@ -3282,7 +3506,10 @@ export type CustomerAccessToken = {
|
|
|
3282
3506
|
/** The date and time when the customer access token expires. */
|
|
3283
3507
|
expiresAt: Scalars['DateTime']['output'];
|
|
3284
3508
|
};
|
|
3285
|
-
/**
|
|
3509
|
+
/**
|
|
3510
|
+
* The input fields for authenticating a customer with email and password. Used by the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation to generate a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken), which is required to read or modify customer data.
|
|
3511
|
+
*
|
|
3512
|
+
*/
|
|
3286
3513
|
export type CustomerAccessTokenCreateInput = {
|
|
3287
3514
|
/** The email associated to the customer. */
|
|
3288
3515
|
email: Scalars['String']['input'];
|
|
@@ -3399,7 +3626,15 @@ export type CustomerAddressUpdatePayload = {
|
|
|
3399
3626
|
*/
|
|
3400
3627
|
userErrors: Array<UserError>;
|
|
3401
3628
|
};
|
|
3402
|
-
/**
|
|
3629
|
+
/**
|
|
3630
|
+
* The input fields for creating a new [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) account. Used by the [`customerCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerCreate) mutation.
|
|
3631
|
+
*
|
|
3632
|
+
* For legacy customer accounts only and requires an email address and password. Optionally accepts the customer's name, phone number, and email marketing consent.
|
|
3633
|
+
*
|
|
3634
|
+
* > Caution:
|
|
3635
|
+
* > The password is used for customer authentication. Ensure it's transmitted securely and never logged or stored in plain text.
|
|
3636
|
+
*
|
|
3637
|
+
*/
|
|
3403
3638
|
export type CustomerCreateInput = {
|
|
3404
3639
|
/** Indicates whether the customer has consented to be sent marketing material via email. */
|
|
3405
3640
|
acceptsMarketing?: InputMaybe<Scalars['Boolean']['input']>;
|
|
@@ -3445,7 +3680,10 @@ export type CustomerDefaultAddressUpdatePayload = {
|
|
|
3445
3680
|
*/
|
|
3446
3681
|
userErrors: Array<UserError>;
|
|
3447
3682
|
};
|
|
3448
|
-
/**
|
|
3683
|
+
/**
|
|
3684
|
+
* Error codes returned by the [`CustomerUserError`](https://shopify.dev/docs/api/storefront/current/objects/CustomerUserError) object. These codes identify specific validation and processing failures for customer-related mutations, including account creation, updates, password resets, and address management.
|
|
3685
|
+
*
|
|
3686
|
+
*/
|
|
3449
3687
|
export declare enum CustomerErrorCode {
|
|
3450
3688
|
/** Customer already enabled. */
|
|
3451
3689
|
AlreadyEnabled = "ALREADY_ENABLED",
|
|
@@ -3526,7 +3764,13 @@ export type CustomerResetPayload = {
|
|
|
3526
3764
|
*/
|
|
3527
3765
|
userErrors: Array<UserError>;
|
|
3528
3766
|
};
|
|
3529
|
-
/**
|
|
3767
|
+
/**
|
|
3768
|
+
* The input fields for updating a [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Used by the [`customerUpdate`](https://shopify.dev/docs/api/storefront/current/mutations/customerUpdate) mutation.
|
|
3769
|
+
*
|
|
3770
|
+
* > Caution:
|
|
3771
|
+
* > Updating the password invalidates all existing access tokens, including the one used to perform the mutation. The response returns a new access token. Ensure your app handles the new token returned in the response to avoid logging the customer out.
|
|
3772
|
+
*
|
|
3773
|
+
*/
|
|
3530
3774
|
export type CustomerUpdateInput = {
|
|
3531
3775
|
/** Indicates whether the customer has consented to be sent marketing material via email. */
|
|
3532
3776
|
acceptsMarketing?: InputMaybe<Scalars['Boolean']['input']>;
|
|
@@ -3599,7 +3843,9 @@ export type DeliveryAddressInput = {
|
|
|
3599
3843
|
oneTimeUse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
3600
3844
|
};
|
|
3601
3845
|
/**
|
|
3602
|
-
*
|
|
3846
|
+
* Controls how delivery addresses are validated during cart operations. The default validation checks only the country code, while strict validation verifies all address fields against Shopify's checkout rules and rejects invalid addresses.
|
|
3847
|
+
*
|
|
3848
|
+
* Used by [`DeliveryAddressInput`](https://shopify.dev/docs/api/storefront/current/input-objects/DeliveryAddressInput) when setting buyer identity preferences, and by [`CartSelectableAddressInput`](https://shopify.dev/docs/api/storefront/current/input-objects/CartSelectableAddressInput) and [`CartSelectableAddressUpdateInput`](https://shopify.dev/docs/api/storefront/current/input-objects/CartSelectableAddressUpdateInput) when managing cart delivery addresses.
|
|
3603
3849
|
*
|
|
3604
3850
|
*/
|
|
3605
3851
|
export declare enum DeliveryAddressValidationStrategy {
|
|
@@ -3639,7 +3885,9 @@ export declare enum DigitalWallet {
|
|
|
3639
3885
|
ShopifyPay = "SHOPIFY_PAY"
|
|
3640
3886
|
}
|
|
3641
3887
|
/**
|
|
3642
|
-
*
|
|
3888
|
+
* The calculated discount amount applied to a line item or shipping line. While a [`DiscountApplication`](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication) captures the discount's rules and intentions, the allocation shows how much was actually deducted.
|
|
3889
|
+
*
|
|
3890
|
+
* Each allocation includes the discounted amount and a reference to the originating discount application.
|
|
3643
3891
|
*
|
|
3644
3892
|
*/
|
|
3645
3893
|
export type DiscountAllocation = {
|
|
@@ -3650,8 +3898,9 @@ export type DiscountAllocation = {
|
|
|
3650
3898
|
discountApplication: DiscountApplication;
|
|
3651
3899
|
};
|
|
3652
3900
|
/**
|
|
3653
|
-
*
|
|
3654
|
-
*
|
|
3901
|
+
* Captures the intent of a discount at the time it was applied. Each implementation represents a different discount source, such as [automatic discounts](https://help.shopify.com/manual/discounts/discount-methods/automatic-discounts), [discount codes](https://help.shopify.com/manual/discounts/discount-methods/discount-codes), and manual discounts.
|
|
3902
|
+
*
|
|
3903
|
+
* The actual discounted amount on a line item or shipping line is represented by the [`DiscountAllocation`](https://shopify.dev/docs/api/storefront/current/objects/DiscountAllocation) object, which references the discount application it originated from.
|
|
3655
3904
|
*
|
|
3656
3905
|
*/
|
|
3657
3906
|
export type DiscountApplication = {
|
|
@@ -3664,7 +3913,12 @@ export type DiscountApplication = {
|
|
|
3664
3913
|
/** The value of the discount application. */
|
|
3665
3914
|
value: PricingValue;
|
|
3666
3915
|
};
|
|
3667
|
-
/**
|
|
3916
|
+
/**
|
|
3917
|
+
* Controls how a discount's value is distributed across entitled lines. A discount can either spread its value across all entitled lines or apply the full value to each line individually.
|
|
3918
|
+
*
|
|
3919
|
+
* Used by the [`DiscountApplication`](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication) interface and its implementations to capture the intentions of a discount source at the time of application.
|
|
3920
|
+
*
|
|
3921
|
+
*/
|
|
3668
3922
|
export declare enum DiscountApplicationAllocationMethod {
|
|
3669
3923
|
/** The value is spread across all entitled lines. */
|
|
3670
3924
|
Across = "ACROSS",
|
|
@@ -3726,8 +3980,10 @@ export declare enum DiscountApplicationTargetType {
|
|
|
3726
3980
|
ShippingLine = "SHIPPING_LINE"
|
|
3727
3981
|
}
|
|
3728
3982
|
/**
|
|
3729
|
-
*
|
|
3730
|
-
*
|
|
3983
|
+
* Records the configuration and intent of a [discount code](https://help.shopify.com/manual/discounts/discount-methods/discount-codes) when a customer applies it. This includes the code string, allocation method, target type, and discount value at the time of application. The [`applicable`](https://shopify.dev/docs/api/storefront/latest/objects/DiscountCodeApplication#field-DiscountCodeApplication.fields.applicable) field indicates whether the code was successfully applied.
|
|
3984
|
+
*
|
|
3985
|
+
* > Note:
|
|
3986
|
+
* > To see the actual amounts discounted on specific line items or shipping lines, use the [`DiscountAllocation`](https://shopify.dev/docs/api/storefront/current/objects/DiscountAllocation) object instead.
|
|
3731
3987
|
*
|
|
3732
3988
|
*/
|
|
3733
3989
|
export type DiscountCodeApplication = DiscountApplication & {
|
|
@@ -3752,7 +4008,10 @@ export type DisplayableError = {
|
|
|
3752
4008
|
/** The error message. */
|
|
3753
4009
|
message: Scalars['String']['output'];
|
|
3754
4010
|
};
|
|
3755
|
-
/**
|
|
4011
|
+
/**
|
|
4012
|
+
* A web address associated with a shop. The [`Shop`](https://shopify.dev/docs/api/storefront/current/objects/Shop) object's [`primaryDomain`](https://shopify.dev/docs/api/storefront/current/objects/Shop#field-Shop.fields.primaryDomain) field returns this to identify the shop's online store URL.
|
|
4013
|
+
*
|
|
4014
|
+
*/
|
|
3756
4015
|
export type Domain = {
|
|
3757
4016
|
__typename?: 'Domain';
|
|
3758
4017
|
/** The host name of the domain (eg: `example.com`). */
|
|
@@ -3787,7 +4046,12 @@ export type ExternalVideo = Media & Node & {
|
|
|
3787
4046
|
/** The preview image for the media. */
|
|
3788
4047
|
previewImage?: Maybe<Image>;
|
|
3789
4048
|
};
|
|
3790
|
-
/**
|
|
4049
|
+
/**
|
|
4050
|
+
* A filter option available on collection and search results pages. Each filter includes a type, display label, and selectable values that customers can use to narrow down products.
|
|
4051
|
+
*
|
|
4052
|
+
* The [`FilterValue`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue) objects contain an [`input`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue#field-FilterValue.fields.input) field that you can combine to [build dynamic filtering queries](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products). Merchants [configure available filters](https://help.shopify.com/manual/online-store/search-and-discovery/filters) using the Shopify Search & Discovery app.
|
|
4053
|
+
*
|
|
4054
|
+
*/
|
|
3791
4055
|
export type Filter = {
|
|
3792
4056
|
__typename?: 'Filter';
|
|
3793
4057
|
/** A unique identifier. */
|
|
@@ -3832,7 +4096,12 @@ export declare enum FilterType {
|
|
|
3832
4096
|
/** A range of prices. */
|
|
3833
4097
|
PriceRange = "PRICE_RANGE"
|
|
3834
4098
|
}
|
|
3835
|
-
/**
|
|
4099
|
+
/**
|
|
4100
|
+
* A selectable option within a [`Filter`](https://shopify.dev/docs/api/storefront/current/objects/Filter), such as a specific color, size, or product type. Each value includes a count of matching results and a human-readable label for display.
|
|
4101
|
+
*
|
|
4102
|
+
* The [`input`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue#field-FilterValue.fields.input) field provides ready-to-use JSON for building dynamic filtering interfaces. You can combine the `input` values from multiple selected [`FilterValue`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue) objects to construct filter queries. Visual representations are available through the [`image`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue#field-FilterValue.fields.image) or [`swatch`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue#field-FilterValue.fields.swatch) fields when the parent filter's presentation type supports them.
|
|
4103
|
+
*
|
|
4104
|
+
*/
|
|
3836
4105
|
export type FilterValue = {
|
|
3837
4106
|
__typename?: 'FilterValue';
|
|
3838
4107
|
/** The number of results that match this filter value. */
|
|
@@ -3855,7 +4124,12 @@ export type FilterValue = {
|
|
|
3855
4124
|
/** The visual representation when the filter's presentation is `SWATCH`. */
|
|
3856
4125
|
swatch?: Maybe<Swatch>;
|
|
3857
4126
|
};
|
|
3858
|
-
/**
|
|
4127
|
+
/**
|
|
4128
|
+
* A shipment of one or more items in an order. Accessed through the [`Order`](https://shopify.dev/docs/api/storefront/current/objects/Order) object's [`successfulFulfillments`](https://shopify.dev/docs/api/storefront/current/objects/Order#field-Order.fields.successfulFulfillments) field.
|
|
4129
|
+
*
|
|
4130
|
+
* Each fulfillment includes the line items that shipped, the tracking company name, and tracking details like numbers and URLs. An order can have multiple fulfillments when items ship separately or from different locations.
|
|
4131
|
+
*
|
|
4132
|
+
*/
|
|
3859
4133
|
export type Fulfillment = {
|
|
3860
4134
|
__typename?: 'Fulfillment';
|
|
3861
4135
|
/** List of the fulfillment's line items. */
|
|
@@ -3869,7 +4143,12 @@ export type Fulfillment = {
|
|
|
3869
4143
|
*/
|
|
3870
4144
|
trackingInfo: Array<FulfillmentTrackingInfo>;
|
|
3871
4145
|
};
|
|
3872
|
-
/**
|
|
4146
|
+
/**
|
|
4147
|
+
* A shipment of one or more items in an order. Accessed through the [`Order`](https://shopify.dev/docs/api/storefront/current/objects/Order) object's [`successfulFulfillments`](https://shopify.dev/docs/api/storefront/current/objects/Order#field-Order.fields.successfulFulfillments) field.
|
|
4148
|
+
*
|
|
4149
|
+
* Each fulfillment includes the line items that shipped, the tracking company name, and tracking details like numbers and URLs. An order can have multiple fulfillments when items ship separately or from different locations.
|
|
4150
|
+
*
|
|
4151
|
+
*/
|
|
3873
4152
|
export type FulfillmentFulfillmentLineItemsArgs = {
|
|
3874
4153
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
3875
4154
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -3877,11 +4156,19 @@ export type FulfillmentFulfillmentLineItemsArgs = {
|
|
|
3877
4156
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
3878
4157
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
3879
4158
|
};
|
|
3880
|
-
/**
|
|
4159
|
+
/**
|
|
4160
|
+
* A shipment of one or more items in an order. Accessed through the [`Order`](https://shopify.dev/docs/api/storefront/current/objects/Order) object's [`successfulFulfillments`](https://shopify.dev/docs/api/storefront/current/objects/Order#field-Order.fields.successfulFulfillments) field.
|
|
4161
|
+
*
|
|
4162
|
+
* Each fulfillment includes the line items that shipped, the tracking company name, and tracking details like numbers and URLs. An order can have multiple fulfillments when items ship separately or from different locations.
|
|
4163
|
+
*
|
|
4164
|
+
*/
|
|
3881
4165
|
export type FulfillmentTrackingInfoArgs = {
|
|
3882
4166
|
first?: InputMaybe<Scalars['Int']['input']>;
|
|
3883
4167
|
};
|
|
3884
|
-
/**
|
|
4168
|
+
/**
|
|
4169
|
+
* Records how many units of an [`OrderLineItem`](https://shopify.dev/docs/api/storefront/current/objects/OrderLineItem) were included in a [`Fulfillment`](https://shopify.dev/docs/api/storefront/current/objects/Fulfillment). Each order line item has at most one fulfillment line item per fulfillment.
|
|
4170
|
+
*
|
|
4171
|
+
*/
|
|
3885
4172
|
export type FulfillmentLineItem = {
|
|
3886
4173
|
__typename?: 'FulfillmentLineItem';
|
|
3887
4174
|
/** The associated order's line item. */
|
|
@@ -3951,30 +4238,55 @@ export type GeoCoordinateInput = {
|
|
|
3951
4238
|
/** The coordinate's longitude value. */
|
|
3952
4239
|
longitude: Scalars['Float']['input'];
|
|
3953
4240
|
};
|
|
3954
|
-
/**
|
|
4241
|
+
/**
|
|
4242
|
+
* Implemented by resources that support custom metadata through [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects. Types like [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), and [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) implement this interface to provide consistent access to metafields.
|
|
4243
|
+
*
|
|
4244
|
+
* You can retrieve a [single metafield](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafield) by namespace and key, or fetch [multiple metafields](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafields) in a single request. If you omit the namespace, then the [app-reserved namespace](https://shopify.dev/docs/apps/build/metafields#app-owned-metafields) is used by default.
|
|
4245
|
+
*
|
|
4246
|
+
*/
|
|
3955
4247
|
export type HasMetafields = {
|
|
3956
4248
|
/** A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. */
|
|
3957
4249
|
metafield?: Maybe<Metafield>;
|
|
3958
4250
|
/** A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. */
|
|
3959
4251
|
metafields: Array<Maybe<Metafield>>;
|
|
3960
4252
|
};
|
|
3961
|
-
/**
|
|
4253
|
+
/**
|
|
4254
|
+
* Implemented by resources that support custom metadata through [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects. Types like [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), and [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) implement this interface to provide consistent access to metafields.
|
|
4255
|
+
*
|
|
4256
|
+
* You can retrieve a [single metafield](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafield) by namespace and key, or fetch [multiple metafields](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafields) in a single request. If you omit the namespace, then the [app-reserved namespace](https://shopify.dev/docs/apps/build/metafields#app-owned-metafields) is used by default.
|
|
4257
|
+
*
|
|
4258
|
+
*/
|
|
3962
4259
|
export type HasMetafieldsMetafieldArgs = {
|
|
3963
4260
|
key: Scalars['String']['input'];
|
|
3964
4261
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
3965
4262
|
};
|
|
3966
|
-
/**
|
|
4263
|
+
/**
|
|
4264
|
+
* Implemented by resources that support custom metadata through [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects. Types like [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), and [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) implement this interface to provide consistent access to metafields.
|
|
4265
|
+
*
|
|
4266
|
+
* You can retrieve a [single metafield](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafield) by namespace and key, or fetch [multiple metafields](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafields) in a single request. If you omit the namespace, then the [app-reserved namespace](https://shopify.dev/docs/apps/build/metafields#app-owned-metafields) is used by default.
|
|
4267
|
+
*
|
|
4268
|
+
*/
|
|
3967
4269
|
export type HasMetafieldsMetafieldsArgs = {
|
|
3968
4270
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
3969
4271
|
};
|
|
3970
|
-
/**
|
|
4272
|
+
/**
|
|
4273
|
+
* The input fields to identify a [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) on an owner resource by namespace and key. Used as an argument to the [`metafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields#fields-metafields) field of the `HasMetafields` interface to retrieve multiple metafields in a single request.
|
|
4274
|
+
*
|
|
4275
|
+
* If you omit the namespace, then the [app-reserved namespace](https://shopify.dev/docs/apps/build/metafields#app-owned-metafields) is used by default.
|
|
4276
|
+
*
|
|
4277
|
+
*/
|
|
3971
4278
|
export type HasMetafieldsIdentifier = {
|
|
3972
4279
|
/** The identifier for the metafield. */
|
|
3973
4280
|
key: Scalars['String']['input'];
|
|
3974
4281
|
/** The container the metafield belongs to. If omitted, the app-reserved namespace will be used. */
|
|
3975
4282
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
3976
4283
|
};
|
|
3977
|
-
/**
|
|
4284
|
+
/**
|
|
4285
|
+
* An image resource with URL, dimensions, and transformation options. Used for product images, collection images, media previews, and other visual content throughout the storefront.
|
|
4286
|
+
*
|
|
4287
|
+
* The [`url`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.url) field accepts an [`ImageTransformInput`](https://shopify.dev/docs/api/storefront/current/input-objects/ImageTransformInput) argument for resizing, cropping, scaling for retina displays, and converting between image formats. Use the [`thumbhash`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.thumbhash) field to display lightweight placeholders while images load.
|
|
4288
|
+
*
|
|
4289
|
+
*/
|
|
3978
4290
|
export type Image = {
|
|
3979
4291
|
__typename?: 'Image';
|
|
3980
4292
|
/** A word or phrase to share the nature or contents of an image. */
|
|
@@ -4028,7 +4340,12 @@ export type Image = {
|
|
|
4028
4340
|
/** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */
|
|
4029
4341
|
width?: Maybe<Scalars['Int']['output']>;
|
|
4030
4342
|
};
|
|
4031
|
-
/**
|
|
4343
|
+
/**
|
|
4344
|
+
* An image resource with URL, dimensions, and transformation options. Used for product images, collection images, media previews, and other visual content throughout the storefront.
|
|
4345
|
+
*
|
|
4346
|
+
* The [`url`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.url) field accepts an [`ImageTransformInput`](https://shopify.dev/docs/api/storefront/current/input-objects/ImageTransformInput) argument for resizing, cropping, scaling for retina displays, and converting between image formats. Use the [`thumbhash`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.thumbhash) field to display lightweight placeholders while images load.
|
|
4347
|
+
*
|
|
4348
|
+
*/
|
|
4032
4349
|
export type ImageTransformedSrcArgs = {
|
|
4033
4350
|
crop?: InputMaybe<CropRegion>;
|
|
4034
4351
|
maxHeight?: InputMaybe<Scalars['Int']['input']>;
|
|
@@ -4036,7 +4353,12 @@ export type ImageTransformedSrcArgs = {
|
|
|
4036
4353
|
preferredContentType?: InputMaybe<ImageContentType>;
|
|
4037
4354
|
scale?: InputMaybe<Scalars['Int']['input']>;
|
|
4038
4355
|
};
|
|
4039
|
-
/**
|
|
4356
|
+
/**
|
|
4357
|
+
* An image resource with URL, dimensions, and transformation options. Used for product images, collection images, media previews, and other visual content throughout the storefront.
|
|
4358
|
+
*
|
|
4359
|
+
* The [`url`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.url) field accepts an [`ImageTransformInput`](https://shopify.dev/docs/api/storefront/current/input-objects/ImageTransformInput) argument for resizing, cropping, scaling for retina displays, and converting between image formats. Use the [`thumbhash`](https://shopify.dev/docs/api/storefront/current/objects/Image#field-Image.fields.thumbhash) field to display lightweight placeholders while images load.
|
|
4360
|
+
*
|
|
4361
|
+
*/
|
|
4040
4362
|
export type ImageUrlArgs = {
|
|
4041
4363
|
transform?: InputMaybe<ImageTransformInput>;
|
|
4042
4364
|
};
|
|
@@ -4126,7 +4448,12 @@ export type InContextAnnotationType = {
|
|
|
4126
4448
|
kind: Scalars['String']['output'];
|
|
4127
4449
|
name: Scalars['String']['output'];
|
|
4128
4450
|
};
|
|
4129
|
-
/**
|
|
4451
|
+
/**
|
|
4452
|
+
* A language available for a localized storefront experience. Provides the language name in both its native form (endonym) and translated into the current language, along with its [`LanguageCode`](https://shopify.dev/docs/api/storefront/current/enums/LanguageCode).
|
|
4453
|
+
*
|
|
4454
|
+
* Returned by the [`Localization`](https://shopify.dev/docs/api/storefront/current/objects/Localization) and [`Country`](https://shopify.dev/docs/api/storefront/current/objects/Country) objects to indicate available and active languages. Pass the `isoCode` to the [`@inContext`](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/in-context) directive to retrieve translated content in that language.
|
|
4455
|
+
*
|
|
4456
|
+
*/
|
|
4130
4457
|
export type Language = {
|
|
4131
4458
|
__typename?: 'Language';
|
|
4132
4459
|
/** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */
|
|
@@ -4136,7 +4463,12 @@ export type Language = {
|
|
|
4136
4463
|
/** The name of the language in the current language. */
|
|
4137
4464
|
name: Scalars['String']['output'];
|
|
4138
4465
|
};
|
|
4139
|
-
/**
|
|
4466
|
+
/**
|
|
4467
|
+
* Supported languages for retrieving translated storefront content. Pass a language code to the [`@inContext`](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/in-context) directive to return product titles, descriptions, and other translatable fields in that language.
|
|
4468
|
+
*
|
|
4469
|
+
* The [`Localization`](https://shopify.dev/docs/api/storefront/current/objects/Localization) object provides the list of available languages for the active country, and each [`Country`](https://shopify.dev/docs/api/storefront/current/objects/Country) in [`availableCountries`](https://shopify.dev/docs/api/storefront/current/objects/Localization#field-Localization.fields.availableCountries) includes its own available languages.
|
|
4470
|
+
*
|
|
4471
|
+
*/
|
|
4140
4472
|
export declare enum LanguageCode {
|
|
4141
4473
|
/** Afrikaans. */
|
|
4142
4474
|
Af = "AF",
|
|
@@ -4427,7 +4759,12 @@ export declare enum LanguageCode {
|
|
|
4427
4759
|
/** Zulu. */
|
|
4428
4760
|
Zu = "ZU"
|
|
4429
4761
|
}
|
|
4430
|
-
/**
|
|
4762
|
+
/**
|
|
4763
|
+
* Information about the shop's configured localized experiences, including available countries and languages. The [`country`](https://shopify.dev/docs/api/storefront/current/objects/Localization#field-Localization.fields.country) and [`language`](https://shopify.dev/docs/api/storefront/current/objects/Localization#field-Localization.fields.language) fields reflect the active localization context, which you can change using the `@inContext` directive on queries.
|
|
4764
|
+
*
|
|
4765
|
+
* Use [`availableCountries`](https://shopify.dev/docs/api/storefront/current/objects/Localization#field-Localization.fields.availableCountries) to list all countries with enabled localized experiences, and [`availableLanguages`](https://shopify.dev/docs/api/storefront/current/objects/Localization#field-Localization.fields.availableLanguages) to get languages available for the currently active country. Each [`Country`](https://shopify.dev/docs/api/storefront/current/objects/Country) includes its own currency, unit system, and available languages.
|
|
4766
|
+
*
|
|
4767
|
+
*/
|
|
4431
4768
|
export type Localization = {
|
|
4432
4769
|
__typename?: 'Localization';
|
|
4433
4770
|
/** The list of countries with enabled localized experiences. */
|
|
@@ -4444,7 +4781,12 @@ export type Localization = {
|
|
|
4444
4781
|
*/
|
|
4445
4782
|
market: Market;
|
|
4446
4783
|
};
|
|
4447
|
-
/**
|
|
4784
|
+
/**
|
|
4785
|
+
* A physical store location where product inventory is held and that supports in-store pickup. Provides the location's name, address, and geographic coordinates for proximity-based sorting. Use with [`StoreAvailability`](https://shopify.dev/docs/api/storefront/current/objects/StoreAvailability) to show customers where a [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) is available for pickup.
|
|
4786
|
+
*
|
|
4787
|
+
* Learn more about [supporting local pickup on storefronts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/local-pickup).
|
|
4788
|
+
*
|
|
4789
|
+
*/
|
|
4448
4790
|
export type Location = HasMetafields & Node & {
|
|
4449
4791
|
__typename?: 'Location';
|
|
4450
4792
|
/** The address of the location. */
|
|
@@ -4458,12 +4800,22 @@ export type Location = HasMetafields & Node & {
|
|
|
4458
4800
|
/** The name of the location. */
|
|
4459
4801
|
name: Scalars['String']['output'];
|
|
4460
4802
|
};
|
|
4461
|
-
/**
|
|
4803
|
+
/**
|
|
4804
|
+
* A physical store location where product inventory is held and that supports in-store pickup. Provides the location's name, address, and geographic coordinates for proximity-based sorting. Use with [`StoreAvailability`](https://shopify.dev/docs/api/storefront/current/objects/StoreAvailability) to show customers where a [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) is available for pickup.
|
|
4805
|
+
*
|
|
4806
|
+
* Learn more about [supporting local pickup on storefronts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/local-pickup).
|
|
4807
|
+
*
|
|
4808
|
+
*/
|
|
4462
4809
|
export type LocationMetafieldArgs = {
|
|
4463
4810
|
key: Scalars['String']['input'];
|
|
4464
4811
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
4465
4812
|
};
|
|
4466
|
-
/**
|
|
4813
|
+
/**
|
|
4814
|
+
* A physical store location where product inventory is held and that supports in-store pickup. Provides the location's name, address, and geographic coordinates for proximity-based sorting. Use with [`StoreAvailability`](https://shopify.dev/docs/api/storefront/current/objects/StoreAvailability) to show customers where a [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) is available for pickup.
|
|
4815
|
+
*
|
|
4816
|
+
* Learn more about [supporting local pickup on storefronts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/local-pickup).
|
|
4817
|
+
*
|
|
4818
|
+
*/
|
|
4467
4819
|
export type LocationMetafieldsArgs = {
|
|
4468
4820
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
4469
4821
|
};
|
|
@@ -4687,7 +5039,7 @@ export type MailingAddressInput = {
|
|
|
4687
5039
|
zip?: InputMaybe<Scalars['String']['input']>;
|
|
4688
5040
|
};
|
|
4689
5041
|
/**
|
|
4690
|
-
*
|
|
5042
|
+
* A discount created manually by a merchant, as opposed to [automatic discounts](https://help.shopify.com/manual/discounts/discount-methods/automatic-discounts) or [discount codes](https://help.shopify.com/manual/discounts/discount-methods/discount-codes). Implements the [`DiscountApplication`](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication) interface and includes a title, optional description, and the discount value as either a fixed amount or percentage.
|
|
4691
5043
|
*
|
|
4692
5044
|
*/
|
|
4693
5045
|
export type ManualDiscountApplication = DiscountApplication & {
|
|
@@ -4705,7 +5057,12 @@ export type ManualDiscountApplication = DiscountApplication & {
|
|
|
4705
5057
|
/** The value of the discount application. */
|
|
4706
5058
|
value: PricingValue;
|
|
4707
5059
|
};
|
|
4708
|
-
/**
|
|
5060
|
+
/**
|
|
5061
|
+
* An audience of buyers that a merchant targets for sales. Audiences can include geographic regions, company locations, and retail locations. Markets enable localized shopping experiences with region-specific languages, currencies, and pricing.
|
|
5062
|
+
*
|
|
5063
|
+
* Each market has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Market#field-Market.fields.handle) for identification and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield). Learn more about [building localized experiences with Shopify Markets](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/markets).
|
|
5064
|
+
*
|
|
5065
|
+
*/
|
|
4709
5066
|
export type Market = HasMetafields & Node & {
|
|
4710
5067
|
__typename?: 'Market';
|
|
4711
5068
|
/**
|
|
@@ -4720,16 +5077,31 @@ export type Market = HasMetafields & Node & {
|
|
|
4720
5077
|
/** A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. */
|
|
4721
5078
|
metafields: Array<Maybe<Metafield>>;
|
|
4722
5079
|
};
|
|
4723
|
-
/**
|
|
5080
|
+
/**
|
|
5081
|
+
* An audience of buyers that a merchant targets for sales. Audiences can include geographic regions, company locations, and retail locations. Markets enable localized shopping experiences with region-specific languages, currencies, and pricing.
|
|
5082
|
+
*
|
|
5083
|
+
* Each market has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Market#field-Market.fields.handle) for identification and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield). Learn more about [building localized experiences with Shopify Markets](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/markets).
|
|
5084
|
+
*
|
|
5085
|
+
*/
|
|
4724
5086
|
export type MarketMetafieldArgs = {
|
|
4725
5087
|
key: Scalars['String']['input'];
|
|
4726
5088
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
4727
5089
|
};
|
|
4728
|
-
/**
|
|
5090
|
+
/**
|
|
5091
|
+
* An audience of buyers that a merchant targets for sales. Audiences can include geographic regions, company locations, and retail locations. Markets enable localized shopping experiences with region-specific languages, currencies, and pricing.
|
|
5092
|
+
*
|
|
5093
|
+
* Each market has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Market#field-Market.fields.handle) for identification and supports custom data through [`metafields`](https://shopify.dev/docs/api/storefront/current/objects/Metafield). Learn more about [building localized experiences with Shopify Markets](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/markets).
|
|
5094
|
+
*
|
|
5095
|
+
*/
|
|
4729
5096
|
export type MarketMetafieldsArgs = {
|
|
4730
5097
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
4731
5098
|
};
|
|
4732
|
-
/**
|
|
5099
|
+
/**
|
|
5100
|
+
* A common set of fields for media content associated with [products](https://shopify.dev/docs/api/storefront/current/objects/Product). Implementations include [`MediaImage`](https://shopify.dev/docs/api/storefront/current/objects/MediaImage) for Shopify-hosted images, [`Video`](https://shopify.dev/docs/api/storefront/current/objects/Video) for Shopify-hosted videos, [`ExternalVideo`](https://shopify.dev/docs/api/storefront/current/objects/ExternalVideo) for videos hosted on platforms like YouTube or Vimeo, and [`Model3d`](https://shopify.dev/docs/api/storefront/current/objects/Model3d) for 3D models.
|
|
5101
|
+
*
|
|
5102
|
+
* Each implementation shares fields for alt text, content type, and preview images, while adding type-specific fields like embed URLs for external videos or source files for 3D models.
|
|
5103
|
+
*
|
|
5104
|
+
*/
|
|
4733
5105
|
export type Media = {
|
|
4734
5106
|
/** A word or phrase to share the nature or contents of a media. */
|
|
4735
5107
|
alt?: Maybe<Scalars['String']['output']>;
|
|
@@ -4828,8 +5200,9 @@ export declare enum MediaPresentationFormat {
|
|
|
4828
5200
|
ModelViewer = "MODEL_VIEWER"
|
|
4829
5201
|
}
|
|
4830
5202
|
/**
|
|
4831
|
-
* A
|
|
4832
|
-
*
|
|
5203
|
+
* A navigation structure for building store [menus](https://help.shopify.com/manual/online-store/menus-and-links). Each menu contains [`MenuItem`](https://shopify.dev/docs/api/storefront/current/objects/MenuItem) objects that can be nested to create multi-level navigation hierarchies.
|
|
5204
|
+
*
|
|
5205
|
+
* Menu items can link to [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), [products](https://shopify.dev/docs/api/storefront/current/objects/Product), [pages](https://shopify.dev/docs/api/storefront/current/objects/Page), [blogs](https://shopify.dev/docs/api/storefront/current/objects/Blog), or external URLs. Use the [`menu`](https://shopify.dev/docs/api/storefront/current/queries/menu) query to retrieve a menu by its handle.
|
|
4833
5206
|
*
|
|
4834
5207
|
*/
|
|
4835
5208
|
export type Menu = Node & {
|
|
@@ -4845,7 +5218,12 @@ export type Menu = Node & {
|
|
|
4845
5218
|
/** The menu's title. */
|
|
4846
5219
|
title: Scalars['String']['output'];
|
|
4847
5220
|
};
|
|
4848
|
-
/**
|
|
5221
|
+
/**
|
|
5222
|
+
* A navigation link within a [`Menu`](https://shopify.dev/docs/api/storefront/current/objects/Menu). Each item has a title, URL, and can link to store resources like [products](https://shopify.dev/docs/api/storefront/current/objects/Product), [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), [pages](https://shopify.dev/docs/api/storefront/current/objects/Page), [blogs](https://shopify.dev/docs/api/storefront/current/objects/Blog), or external URLs.
|
|
5223
|
+
*
|
|
5224
|
+
* Menu items support nested hierarchies through the [`items`](https://shopify.dev/docs/api/storefront/current/objects/MenuItem#field-MenuItem.fields.items) field, enabling dropdown or multi-level navigation structures. The [`tags`](https://shopify.dev/docs/api/storefront/current/objects/MenuItem#field-MenuItem.fields.tags) field filters results when the item links to a collection specifically.
|
|
5225
|
+
*
|
|
5226
|
+
*/
|
|
4849
5227
|
export type MenuItem = Node & {
|
|
4850
5228
|
__typename?: 'MenuItem';
|
|
4851
5229
|
/** A globally-unique ID. */
|
|
@@ -4899,11 +5277,15 @@ export declare enum MenuItemType {
|
|
|
4899
5277
|
/** A shop policy link. */
|
|
4900
5278
|
ShopPolicy = "SHOP_POLICY"
|
|
4901
5279
|
}
|
|
4902
|
-
/**
|
|
5280
|
+
/**
|
|
5281
|
+
* A [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) that a buyer intends to purchase at checkout.
|
|
5282
|
+
*
|
|
5283
|
+
*/
|
|
4903
5284
|
export type Merchandise = ProductVariant;
|
|
4904
5285
|
/**
|
|
4905
|
-
*
|
|
4906
|
-
*
|
|
5286
|
+
* [Custom metadata](https://shopify.dev/docs/apps/build/metafields) attached to a Shopify resource such as a [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), or [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Each metafield is identified by a namespace and key, and stores a value with an associated type.
|
|
5287
|
+
*
|
|
5288
|
+
* Values are always stored as strings, but the [`type`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.type) field indicates how to interpret the data. When a metafield's type is a resource reference, use the [`reference`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.reference) or [`references`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.references) fields to retrieve the linked objects. Access metafields on any resource that implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface.
|
|
4907
5289
|
*
|
|
4908
5290
|
*/
|
|
4909
5291
|
export type Metafield = Node & {
|
|
@@ -4916,6 +5298,8 @@ export type Metafield = Node & {
|
|
|
4916
5298
|
id: Scalars['ID']['output'];
|
|
4917
5299
|
/** The unique identifier for the metafield within its namespace. */
|
|
4918
5300
|
key: Scalars['String']['output'];
|
|
5301
|
+
/** Whether the metafield's type is a list type. Returns `true` for types like `list.color` or `list.single_line_text_field`. */
|
|
5302
|
+
list: Scalars['Boolean']['output'];
|
|
4919
5303
|
/** The container for a group of metafields that the metafield is associated with. */
|
|
4920
5304
|
namespace: Scalars['String']['output'];
|
|
4921
5305
|
/** The type of resource that the metafield is attached to. */
|
|
@@ -4936,8 +5320,9 @@ export type Metafield = Node & {
|
|
|
4936
5320
|
value: Scalars['String']['output'];
|
|
4937
5321
|
};
|
|
4938
5322
|
/**
|
|
4939
|
-
*
|
|
4940
|
-
*
|
|
5323
|
+
* [Custom metadata](https://shopify.dev/docs/apps/build/metafields) attached to a Shopify resource such as a [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), or [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Each metafield is identified by a namespace and key, and stores a value with an associated type.
|
|
5324
|
+
*
|
|
5325
|
+
* Values are always stored as strings, but the [`type`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.type) field indicates how to interpret the data. When a metafield's type is a resource reference, use the [`reference`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.reference) or [`references`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.references) fields to retrieve the linked objects. Access metafields on any resource that implements the [`HasMetafields`](https://shopify.dev/docs/api/storefront/current/interfaces/HasMetafields) interface.
|
|
4941
5326
|
*
|
|
4942
5327
|
*/
|
|
4943
5328
|
export type MetafieldReferencesArgs = {
|
|
@@ -4966,13 +5351,9 @@ export type MetafieldDeleteUserError = DisplayableError & {
|
|
|
4966
5351
|
message: Scalars['String']['output'];
|
|
4967
5352
|
};
|
|
4968
5353
|
/**
|
|
4969
|
-
*
|
|
5354
|
+
* Filters products in a collection by matching a specific metafield value. Used by the [`ProductFilter`](https://shopify.dev/docs/api/storefront/current/input-objects/ProductFilter) input's `productMetafield` and `variantMetafield` fields.
|
|
4970
5355
|
*
|
|
4971
|
-
*
|
|
4972
|
-
* - `number_integer`
|
|
4973
|
-
* - `number_decimal`
|
|
4974
|
-
* - `single_line_text_field`
|
|
4975
|
-
* - `boolean` as of 2022-04.
|
|
5356
|
+
* Supports the following metafield types: `number_integer`, `number_decimal`, `single_line_text_field`, and `boolean`.
|
|
4976
5357
|
*
|
|
4977
5358
|
*/
|
|
4978
5359
|
export type MetafieldFilter = {
|
|
@@ -4983,10 +5364,15 @@ export type MetafieldFilter = {
|
|
|
4983
5364
|
/** The value of the metafield. */
|
|
4984
5365
|
value: Scalars['String']['input'];
|
|
4985
5366
|
};
|
|
4986
|
-
/**
|
|
5367
|
+
/**
|
|
5368
|
+
* The Shopify resource that owns a metafield. Returned by the `Metafield` object's [`parentResource`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.parentResource) field, enabling traversal from a metafield back to the resource it's attached to.
|
|
5369
|
+
*
|
|
5370
|
+
*/
|
|
4987
5371
|
export type MetafieldParentResource = Article | Blog | Cart | Collection | Company | CompanyLocation | Customer | Location | Market | Order | Page | Product | ProductVariant | SellingPlan | Shop;
|
|
4988
5372
|
/**
|
|
4989
|
-
*
|
|
5373
|
+
* The resource that a metafield points to when its type is a resource reference. Metafields can store references to other Shopify resources, and this union provides access to the actual referenced object.
|
|
5374
|
+
*
|
|
5375
|
+
* Returned by the `Metafield` object's [`reference`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.reference) field for single references or the [`references`](https://shopify.dev/docs/api/storefront/current/objects/Metafield#field-Metafield.fields.references) field for lists.
|
|
4990
5376
|
*
|
|
4991
5377
|
*/
|
|
4992
5378
|
export type MetafieldReference = Article | Collection | GenericFile | MediaImage | Metaobject | Model3d | Page | Product | ProductVariant | Video;
|
|
@@ -5049,7 +5435,12 @@ export declare enum MetafieldsSetUserErrorCode {
|
|
|
5049
5435
|
/** The input value is too short. */
|
|
5050
5436
|
TooShort = "TOO_SHORT"
|
|
5051
5437
|
}
|
|
5052
|
-
/**
|
|
5438
|
+
/**
|
|
5439
|
+
* An instance of [custom structured data](https://shopify.dev/docs/apps/build/metaobjects) defined by a metaobject definition. Metaobjects store reusable content that extends beyond standard Shopify resources, such as size charts, author profiles, or custom content sections.
|
|
5440
|
+
*
|
|
5441
|
+
* Each metaobject contains fields that match the types and validation rules specified in its definition. [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) references can point to metaobjects, connecting custom data with products, collections, and other resources. If the definition has the `renderable` capability, then the [`seo`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject#field-Metaobject.fields.seo) field provides SEO metadata. If it has the `online_store` capability, then the [`onlineStoreUrl`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject#field-Metaobject.fields.onlineStoreUrl) field returns the public URL.
|
|
5442
|
+
*
|
|
5443
|
+
*/
|
|
5053
5444
|
export type Metaobject = Node & OnlineStorePublishable & {
|
|
5054
5445
|
__typename?: 'Metaobject';
|
|
5055
5446
|
/** Accesses a field of the object by key. */
|
|
@@ -5077,7 +5468,12 @@ export type Metaobject = Node & OnlineStorePublishable & {
|
|
|
5077
5468
|
/** The date and time when the metaobject was last updated. */
|
|
5078
5469
|
updatedAt: Scalars['DateTime']['output'];
|
|
5079
5470
|
};
|
|
5080
|
-
/**
|
|
5471
|
+
/**
|
|
5472
|
+
* An instance of [custom structured data](https://shopify.dev/docs/apps/build/metaobjects) defined by a metaobject definition. Metaobjects store reusable content that extends beyond standard Shopify resources, such as size charts, author profiles, or custom content sections.
|
|
5473
|
+
*
|
|
5474
|
+
* Each metaobject contains fields that match the types and validation rules specified in its definition. [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) references can point to metaobjects, connecting custom data with products, collections, and other resources. If the definition has the `renderable` capability, then the [`seo`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject#field-Metaobject.fields.seo) field provides SEO metadata. If it has the `online_store` capability, then the [`onlineStoreUrl`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject#field-Metaobject.fields.onlineStoreUrl) field returns the public URL.
|
|
5475
|
+
*
|
|
5476
|
+
*/
|
|
5081
5477
|
export type MetaobjectFieldArgs = {
|
|
5082
5478
|
key: Scalars['String']['input'];
|
|
5083
5479
|
};
|
|
@@ -5105,7 +5501,10 @@ export type MetaobjectEdge = {
|
|
|
5105
5501
|
/** The item at the end of MetaobjectEdge. */
|
|
5106
5502
|
node: Metaobject;
|
|
5107
5503
|
};
|
|
5108
|
-
/**
|
|
5504
|
+
/**
|
|
5505
|
+
* The value of a field within a [`Metaobject`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject). For fields that reference other resources, use the [`reference`](https://shopify.dev/docs/api/storefront/current/objects/MetaobjectField#field-MetaobjectField.fields.reference) field for single references or [`references`](https://shopify.dev/docs/api/storefront/current/objects/MetaobjectField#field-MetaobjectField.fields.references) for lists.
|
|
5506
|
+
*
|
|
5507
|
+
*/
|
|
5109
5508
|
export type MetaobjectField = {
|
|
5110
5509
|
__typename?: 'MetaobjectField';
|
|
5111
5510
|
/** The field key. */
|
|
@@ -5123,7 +5522,10 @@ export type MetaobjectField = {
|
|
|
5123
5522
|
/** The field value. */
|
|
5124
5523
|
value?: Maybe<Scalars['String']['output']>;
|
|
5125
5524
|
};
|
|
5126
|
-
/**
|
|
5525
|
+
/**
|
|
5526
|
+
* The value of a field within a [`Metaobject`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject). For fields that reference other resources, use the [`reference`](https://shopify.dev/docs/api/storefront/current/objects/MetaobjectField#field-MetaobjectField.fields.reference) field for single references or [`references`](https://shopify.dev/docs/api/storefront/current/objects/MetaobjectField#field-MetaobjectField.fields.references) for lists.
|
|
5527
|
+
*
|
|
5528
|
+
*/
|
|
5127
5529
|
export type MetaobjectFieldReferencesArgs = {
|
|
5128
5530
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
5129
5531
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -5181,7 +5583,7 @@ export type MoneyInput = {
|
|
|
5181
5583
|
currencyCode: CurrencyCode;
|
|
5182
5584
|
};
|
|
5183
5585
|
/**
|
|
5184
|
-
* A monetary value with currency.
|
|
5586
|
+
* A precise monetary value with its associated currency. Combines a decimal amount with a three-letter [`CurrencyCode`](https://shopify.dev/docs/api/storefront/current/enums/CurrencyCode) to express prices, costs, and other financial values. For example, 12.99 USD.
|
|
5185
5587
|
*
|
|
5186
5588
|
*/
|
|
5187
5589
|
export type MoneyV2 = {
|
|
@@ -5217,13 +5619,27 @@ export type Mutation = {
|
|
|
5217
5619
|
*
|
|
5218
5620
|
*/
|
|
5219
5621
|
cartCreate?: Maybe<CartCreatePayload>;
|
|
5220
|
-
/**
|
|
5622
|
+
/**
|
|
5623
|
+
* Adds delivery addresses to a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). A cart can have up to 20 delivery addresses. One address can be marked as selected for checkout, and addresses can optionally be marked as one-time use so they aren't saved to the customer's account.
|
|
5624
|
+
*
|
|
5625
|
+
*/
|
|
5221
5626
|
cartDeliveryAddressesAdd?: Maybe<CartDeliveryAddressesAddPayload>;
|
|
5222
|
-
/**
|
|
5627
|
+
/**
|
|
5628
|
+
* Removes delivery addresses from a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart) by their IDs, allowing batch removal in a single request.
|
|
5629
|
+
*
|
|
5630
|
+
*/
|
|
5223
5631
|
cartDeliveryAddressesRemove?: Maybe<CartDeliveryAddressesRemovePayload>;
|
|
5224
|
-
/**
|
|
5632
|
+
/**
|
|
5633
|
+
* Replaces all delivery addresses on a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart) with a new set of addresses in a single operation. Unlike [`cartDeliveryAddressesUpdate`](https://shopify.dev/docs/api/storefront/current/mutations/cartDeliveryAddressesUpdate), which modifies existing addresses, this mutation removes all current addresses and sets the provided list as the new delivery addresses.
|
|
5634
|
+
*
|
|
5635
|
+
* One address can be marked as selected, and each address can be flagged for one-time use or configured with a specific validation strategy.
|
|
5636
|
+
*
|
|
5637
|
+
*/
|
|
5225
5638
|
cartDeliveryAddressesReplace?: Maybe<CartDeliveryAddressesReplacePayload>;
|
|
5226
|
-
/**
|
|
5639
|
+
/**
|
|
5640
|
+
* Updates one or more delivery addresses on a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). Each address can be modified to change its details, set it as the pre-selected address for checkout, or mark it for one-time use so it isn't saved to the customer's account.
|
|
5641
|
+
*
|
|
5642
|
+
*/
|
|
5227
5643
|
cartDeliveryAddressesUpdate?: Maybe<CartDeliveryAddressesUpdatePayload>;
|
|
5228
5644
|
/**
|
|
5229
5645
|
* Updates the discount codes applied to a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). This mutation replaces all existing discount codes with the provided list, so pass an empty array to remove all codes. Discount codes are case-insensitive.
|
|
@@ -5249,11 +5665,24 @@ export type Mutation = {
|
|
|
5249
5665
|
*
|
|
5250
5666
|
*/
|
|
5251
5667
|
cartGiftCardCodesUpdate?: Maybe<CartGiftCardCodesUpdatePayload>;
|
|
5252
|
-
/**
|
|
5668
|
+
/**
|
|
5669
|
+
* Adds one or more merchandise lines to an existing [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). Each line specifies the [product variant](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) to purchase. Quantity defaults to `1` if not provided.
|
|
5670
|
+
*
|
|
5671
|
+
* You can add up to 250 lines in a single request. Use [`CartLineInput`](https://shopify.dev/docs/api/storefront/current/input-objects/CartLineInput) to configure each line's merchandise, quantity, selling plan, custom attributes, and any parent relationships for nested line items such as warranties or add-ons.
|
|
5672
|
+
*
|
|
5673
|
+
*/
|
|
5253
5674
|
cartLinesAdd?: Maybe<CartLinesAddPayload>;
|
|
5254
|
-
/**
|
|
5675
|
+
/**
|
|
5676
|
+
* Removes one or more merchandise lines from a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). Accepts up to 250 line IDs per request. Returns the updated cart along with any errors or warnings.
|
|
5677
|
+
*
|
|
5678
|
+
*/
|
|
5255
5679
|
cartLinesRemove?: Maybe<CartLinesRemovePayload>;
|
|
5256
|
-
/**
|
|
5680
|
+
/**
|
|
5681
|
+
* Updates one or more merchandise lines on a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart). You can modify the quantity, swap the merchandise, change custom attributes, or update the selling plan for each line. You can update a maximum of 250 lines per request.
|
|
5682
|
+
*
|
|
5683
|
+
* Omitting the [`attributes`](https://shopify.dev/docs/api/storefront/current/mutations/cartLinesUpdate#arguments-lines.fields.attributes) field or setting it to null preserves existing line attributes. Pass an empty array to clear all attributes from a line.
|
|
5684
|
+
*
|
|
5685
|
+
*/
|
|
5257
5686
|
cartLinesUpdate?: Maybe<CartLinesUpdatePayload>;
|
|
5258
5687
|
/**
|
|
5259
5688
|
* Deletes a cart metafield.
|
|
@@ -5264,14 +5693,12 @@ export type Mutation = {
|
|
|
5264
5693
|
*/
|
|
5265
5694
|
cartMetafieldDelete?: Maybe<CartMetafieldDeletePayload>;
|
|
5266
5695
|
/**
|
|
5267
|
-
* Sets
|
|
5696
|
+
* Sets [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) values on a cart, creating new metafields or updating existing ones. Accepts up to 25 metafields per request.
|
|
5268
5697
|
*
|
|
5269
|
-
*
|
|
5270
|
-
*
|
|
5271
|
-
* Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.
|
|
5698
|
+
* Cart metafields can automatically copy to order metafields when an order is created, if there's a matching order metafield definition with the [cart to order copyable](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.
|
|
5272
5699
|
*
|
|
5273
5700
|
* > Note:
|
|
5274
|
-
* > This mutation
|
|
5701
|
+
* > This mutation doesn't trigger [Shopify Functions](https://shopify.dev/docs/api/functions). Changes aren't available to Shopify Functions until the buyer goes to checkout or performs another cart interaction that triggers the functions.
|
|
5275
5702
|
*
|
|
5276
5703
|
*/
|
|
5277
5704
|
cartMetafieldsSet?: Maybe<CartMetafieldsSetPayload>;
|
|
@@ -5296,74 +5723,155 @@ export type Mutation = {
|
|
|
5296
5723
|
/** Submit the cart for checkout completion. */
|
|
5297
5724
|
cartSubmitForCompletion?: Maybe<CartSubmitForCompletionPayload>;
|
|
5298
5725
|
/**
|
|
5299
|
-
*
|
|
5300
|
-
*
|
|
5726
|
+
* For legacy customer accounts only.
|
|
5727
|
+
*
|
|
5728
|
+
* Creates a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) using the customer's email and password. The access token is required to read or modify the [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) object, such as updating account information or managing addresses.
|
|
5729
|
+
*
|
|
5730
|
+
* The token has an expiration time. Use [`customerAccessTokenRenew`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenRenew) to extend the token before it expires, or create a new token if it's already expired.
|
|
5731
|
+
*
|
|
5732
|
+
* > Caution:
|
|
5733
|
+
* > This mutation handles customer credentials. Always transmit requests over HTTPS and never log or expose the password.
|
|
5301
5734
|
*
|
|
5302
5735
|
*/
|
|
5303
5736
|
customerAccessTokenCreate?: Maybe<CustomerAccessTokenCreatePayload>;
|
|
5304
5737
|
/**
|
|
5305
|
-
* Creates a
|
|
5306
|
-
*
|
|
5307
|
-
*
|
|
5308
|
-
*
|
|
5738
|
+
* Creates a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) using a [multipass token](https://shopify.dev/docs/api/multipass) instead of email and password. This enables single sign-on for customers who authenticate through an external system.
|
|
5739
|
+
*
|
|
5740
|
+
* If the customer doesn't exist in Shopify, then a new customer record is created automatically. If the customer exists but the record is disabled, then the customer record is re-enabled.
|
|
5741
|
+
*
|
|
5742
|
+
* > Caution:
|
|
5743
|
+
* > Multipass tokens are only valid for 15 minutes and can only be used once. Generate tokens on-the-fly when needed rather than in advance.
|
|
5309
5744
|
*
|
|
5310
5745
|
*/
|
|
5311
5746
|
customerAccessTokenCreateWithMultipass?: Maybe<CustomerAccessTokenCreateWithMultipassPayload>;
|
|
5312
|
-
/**
|
|
5747
|
+
/**
|
|
5748
|
+
* Permanently destroys a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken). Use this mutation when a customer explicitly signs out or when you need to revoke the token. Use [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) to generate a new token with the customer's credentials.
|
|
5749
|
+
*
|
|
5750
|
+
* > Caution:
|
|
5751
|
+
* > This action is irreversible. The customer needs to sign in again to obtain a new access token.
|
|
5752
|
+
*
|
|
5753
|
+
*/
|
|
5313
5754
|
customerAccessTokenDelete?: Maybe<CustomerAccessTokenDeletePayload>;
|
|
5314
5755
|
/**
|
|
5315
|
-
*
|
|
5756
|
+
* Extends the validity of a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) before it expires. The renewed token maintains authenticated access to customer operations.
|
|
5757
|
+
*
|
|
5758
|
+
* Renewal must happen before the token's [`expiresAt`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken#field-CustomerAccessToken.fields.expiresAt) time. If a token has already expired, then use [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) to generate a new token with the customer's credentials.
|
|
5316
5759
|
*
|
|
5317
|
-
*
|
|
5318
|
-
*
|
|
5760
|
+
* > Caution:
|
|
5761
|
+
* > Store access tokens securely. Never store tokens in plain text or insecure locations, and avoid exposing them in URLs or logs.
|
|
5319
5762
|
*
|
|
5320
5763
|
*/
|
|
5321
5764
|
customerAccessTokenRenew?: Maybe<CustomerAccessTokenRenewPayload>;
|
|
5322
|
-
/**
|
|
5765
|
+
/**
|
|
5766
|
+
* Activates a customer account using an activation token received from the [`customerCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerCreate) mutation. The customer sets their password during activation and receives a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) for authenticated access.
|
|
5767
|
+
*
|
|
5768
|
+
* For a simpler approach that doesn't require parsing the activation URL, use [`customerActivateByUrl`](https://shopify.dev/docs/api/storefront/current/mutations/customerActivateByUrl) instead.
|
|
5769
|
+
*
|
|
5770
|
+
* > Caution:
|
|
5771
|
+
* > This mutation handles customer credentials. Always use HTTPS and never log or expose the password or access token.
|
|
5772
|
+
*
|
|
5773
|
+
*/
|
|
5323
5774
|
customerActivate?: Maybe<CustomerActivatePayload>;
|
|
5324
|
-
/**
|
|
5775
|
+
/**
|
|
5776
|
+
* Activates a customer account using the full activation URL from the [`customerCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerCreate) mutation. This approach simplifies activation by accepting the complete URL directly, eliminating the need to parse it for the customer ID and activation token. Returns a [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) for authenticating subsequent requests.
|
|
5777
|
+
*
|
|
5778
|
+
* > Caution:
|
|
5779
|
+
* > Store the returned access token securely. It grants access to the customer's account data.
|
|
5780
|
+
*
|
|
5781
|
+
*/
|
|
5325
5782
|
customerActivateByUrl?: Maybe<CustomerActivateByUrlPayload>;
|
|
5326
|
-
/**
|
|
5783
|
+
/**
|
|
5784
|
+
* Creates a new [`MailingAddress`](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) for a [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Use the customer's [access token](https://shopify.dev/docs/api/storefront/current/mutations/customerAddressCreate#arguments-customerAccessToken) to identify them. Successful creation returns the new address.
|
|
5785
|
+
*
|
|
5786
|
+
* Each customer can have multiple addresses.
|
|
5787
|
+
*
|
|
5788
|
+
*/
|
|
5327
5789
|
customerAddressCreate?: Maybe<CustomerAddressCreatePayload>;
|
|
5328
|
-
/**
|
|
5790
|
+
/**
|
|
5791
|
+
* Permanently deletes a specific [`MailingAddress`](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) for a [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Requires a valid [customer access token](https://shopify.dev/docs/api/storefront/current/mutations/customerAddressDelete#arguments-customerAccessToken) to authenticate the request.
|
|
5792
|
+
*
|
|
5793
|
+
* > Caution:
|
|
5794
|
+
* > This action is irreversible. You can't recover the deleted address.
|
|
5795
|
+
*
|
|
5796
|
+
*/
|
|
5329
5797
|
customerAddressDelete?: Maybe<CustomerAddressDeletePayload>;
|
|
5330
|
-
/**
|
|
5798
|
+
/**
|
|
5799
|
+
* Updates an existing [`MailingAddress`](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress) for a [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Requires a [customer access token](https://shopify.dev/docs/api/storefront/current/mutations/customerAddressUpdate#arguments-customerAccessToken) to identify the customer, an ID to specify which address to modify, and an [`address`](https://shopify.dev/docs/api/storefront/current/input-objects/MailingAddressInput) with the updated fields.
|
|
5800
|
+
*
|
|
5801
|
+
* Successful update returns the updated [`MailingAddress`](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress).
|
|
5802
|
+
*
|
|
5803
|
+
*/
|
|
5331
5804
|
customerAddressUpdate?: Maybe<CustomerAddressUpdatePayload>;
|
|
5332
|
-
/**
|
|
5805
|
+
/**
|
|
5806
|
+
* Creates a new [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) account with the provided contact information and login credentials. The customer can then sign in for things such as accessing their account, viewing order history, and managing saved addresses.
|
|
5807
|
+
*
|
|
5808
|
+
* > Caution:
|
|
5809
|
+
* > This mutation creates customer credentials. Ensure passwords are collected securely and never logged or exposed in client-side code.
|
|
5810
|
+
*
|
|
5811
|
+
*/
|
|
5333
5812
|
customerCreate?: Maybe<CustomerCreatePayload>;
|
|
5334
|
-
/**
|
|
5813
|
+
/**
|
|
5814
|
+
* Updates the default address of an existing [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer). Requires a [customer access token](https://shopify.dev/docs/api/storefront/current/mutations/customerDefaultAddressUpdate#arguments-customerAccessToken) to identify the customer and an address ID to specify which address to set as the new default.
|
|
5815
|
+
*
|
|
5816
|
+
*/
|
|
5335
5817
|
customerDefaultAddressUpdate?: Maybe<CustomerDefaultAddressUpdatePayload>;
|
|
5336
5818
|
/**
|
|
5337
|
-
* Sends a reset password email to the customer. The reset password
|
|
5338
|
-
* email contains a reset password URL and token that you can pass to
|
|
5339
|
-
* the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or
|
|
5340
|
-
* [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the
|
|
5341
|
-
* customer password.
|
|
5819
|
+
* Sends a reset password email to the customer. The email contains a reset password URL and token that you can pass to the [`customerResetByUrl`](https://shopify.dev/docs/api/storefront/current/mutations/customerResetByUrl) or [`customerReset`](https://shopify.dev/docs/api/storefront/current/mutations/customerReset) mutation to reset the customer's password.
|
|
5342
5820
|
*
|
|
5343
|
-
* This mutation is throttled by IP. With private access,
|
|
5344
|
-
* you can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP.
|
|
5345
|
-
* The header is case-sensitive and must be sent as `Shopify-Storefront-Buyer-IP`.
|
|
5821
|
+
* This mutation is throttled by IP. With private access, you can provide a [`Shopify-Storefront-Buyer-IP` header](https://shopify.dev/docs/api/usage/authentication#optional-ip-header) instead of the request IP. The header is case-sensitive.
|
|
5346
5822
|
*
|
|
5347
|
-
*
|
|
5348
|
-
* mutation presents a security risk.
|
|
5823
|
+
* > Caution:
|
|
5824
|
+
* > Ensure the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this mutation presents a security risk.
|
|
5349
5825
|
*
|
|
5350
5826
|
*/
|
|
5351
5827
|
customerRecover?: Maybe<CustomerRecoverPayload>;
|
|
5352
5828
|
/**
|
|
5353
|
-
*
|
|
5829
|
+
* Resets a customer's password using the reset token from a password recovery email. On success, returns the updated [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) and a new [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) for immediate authentication.
|
|
5830
|
+
*
|
|
5831
|
+
* Use the [`customerRecover`](https://shopify.dev/docs/api/storefront/current/mutations/customerRecover) mutation to send the password recovery email that provides the reset token. Alternatively, use [`customerResetByUrl`](https://shopify.dev/docs/api/storefront/current/mutations/customerResetByUrl) if you have the full reset URL instead of the customer ID and token.
|
|
5832
|
+
*
|
|
5833
|
+
* > Caution:
|
|
5834
|
+
* > This mutation handles sensitive customer credentials. Validate password requirements on the client before submission.
|
|
5354
5835
|
*
|
|
5355
5836
|
*/
|
|
5356
5837
|
customerReset?: Maybe<CustomerResetPayload>;
|
|
5357
5838
|
/**
|
|
5358
|
-
*
|
|
5839
|
+
* Resets a customer's password using the reset URL from a password recovery email. The reset URL is generated by the [`customerRecover`](https://shopify.dev/docs/api/storefront/current/mutations/customerRecover) mutation.
|
|
5840
|
+
*
|
|
5841
|
+
* On success, returns the updated [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) and a new [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) for immediate authentication.
|
|
5842
|
+
*
|
|
5843
|
+
* > Caution:
|
|
5844
|
+
* > This mutation handles customer credentials. Ensure the new password is transmitted securely and never logged or exposed in client-side code.
|
|
5359
5845
|
*
|
|
5360
5846
|
*/
|
|
5361
5847
|
customerResetByUrl?: Maybe<CustomerResetByUrlPayload>;
|
|
5362
|
-
/**
|
|
5848
|
+
/**
|
|
5849
|
+
* Updates a [customer's](https://shopify.dev/docs/api/storefront/current/objects/Customer) personal information such as name, password, and marketing preferences. Requires a valid [`CustomerAccessToken`](https://shopify.dev/docs/api/storefront/current/objects/CustomerAccessToken) to authenticate the customer making the update.
|
|
5850
|
+
*
|
|
5851
|
+
* If the customer's password is updated, then all previous access tokens become invalid. The mutation returns a new access token in the payload to maintain the customer's session.
|
|
5852
|
+
*
|
|
5853
|
+
* > Caution:
|
|
5854
|
+
* > Password changes invalidate all existing access tokens. Ensure your app handles the new token returned in the response to avoid logging the customer out.
|
|
5855
|
+
*
|
|
5856
|
+
*/
|
|
5363
5857
|
customerUpdate?: Maybe<CustomerUpdatePayload>;
|
|
5364
|
-
/**
|
|
5858
|
+
/**
|
|
5859
|
+
* Creates a [Shop Pay payment request session](https://shopify.dev/docs/api/storefront/current/objects/ShopPayPaymentRequestSession) for processing payments. The session includes a checkout URL where customers complete their purchase and a token for subsequent operations like submitting the payment.
|
|
5860
|
+
*
|
|
5861
|
+
* The `sourceIdentifier` must be unique across all orders to ensure accurate reconciliation.
|
|
5862
|
+
*
|
|
5863
|
+
* For a complete integration guide including the JavaScript SDK setup and checkout flow, refer to the [Shop Component API documentation](https://shopify.dev/docs/api/commerce-components/pay). For implementation steps, see the [development journey guide](https://shopify.dev/docs/api/commerce-components/pay/development-journey). For common error scenarios, see the [troubleshooting guide](https://shopify.dev/docs/api/commerce-components/pay/troubleshooting-guide).
|
|
5864
|
+
*
|
|
5865
|
+
*/
|
|
5365
5866
|
shopPayPaymentRequestSessionCreate?: Maybe<ShopPayPaymentRequestSessionCreatePayload>;
|
|
5366
|
-
/**
|
|
5867
|
+
/**
|
|
5868
|
+
* Finalizes a [Shop Pay payment request session](https://shopify.dev/docs/api/storefront/current/objects/ShopPayPaymentRequestSession). Call this mutation after creating a session with [`shopPayPaymentRequestSessionCreate`](https://shopify.dev/docs/api/storefront/current/mutations/shopPayPaymentRequestSessionCreate).
|
|
5869
|
+
*
|
|
5870
|
+
* The [`idempotencyKey`](https://shopify.dev/docs/api/storefront/current/mutations/shopPayPaymentRequestSessionSubmit#arguments-idempotencyKey) argument ensures the payment transaction occurs only once, preventing duplicate charges. On success, returns a [`ShopPayPaymentRequestReceipt`](https://shopify.dev/docs/api/storefront/current/objects/ShopPayPaymentRequestReceipt) with the processing status and a receipt token.
|
|
5871
|
+
*
|
|
5872
|
+
* For a complete integration guide including the JavaScript SDK setup and checkout flow, refer to the [Shop Component API documentation](https://shopify.dev/docs/api/commerce-components/pay). For implementation steps, see the [development journey guide](https://shopify.dev/docs/api/commerce-components/pay/development-journey). For common error scenarios, see the [troubleshooting guide](https://shopify.dev/docs/api/commerce-components/pay/troubleshooting-guide).
|
|
5873
|
+
*
|
|
5874
|
+
*/
|
|
5367
5875
|
shopPayPaymentRequestSessionSubmit?: Maybe<ShopPayPaymentRequestSessionSubmitPayload>;
|
|
5368
5876
|
};
|
|
5369
5877
|
/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */
|
|
@@ -5563,10 +6071,7 @@ export type MutationShopPayPaymentRequestSessionSubmitArgs = {
|
|
|
5563
6071
|
token: Scalars['String']['input'];
|
|
5564
6072
|
};
|
|
5565
6073
|
/**
|
|
5566
|
-
*
|
|
5567
|
-
* [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).
|
|
5568
|
-
* This interface is used by the [node](/docs/api/storefront/latest/queries/node)
|
|
5569
|
-
* and [nodes](/docs/api/storefront/latest/queries/nodes) queries.
|
|
6074
|
+
* Enables global object identification following the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). Any type implementing this interface has a globally-unique `id` field and can be fetched directly using the [`node`](https://shopify.dev/docs/api/storefront/current/queries/node) or [`nodes`](https://shopify.dev/docs/api/storefront/current/queries/nodes) queries.
|
|
5570
6075
|
*
|
|
5571
6076
|
*/
|
|
5572
6077
|
export type Node = {
|
|
@@ -5778,7 +6283,14 @@ export declare enum OrderFinancialStatus {
|
|
|
5778
6283
|
/** Displayed as **Voided**. */
|
|
5779
6284
|
Voided = "VOIDED"
|
|
5780
6285
|
}
|
|
5781
|
-
/**
|
|
6286
|
+
/**
|
|
6287
|
+
* The aggregated fulfillment status of an [`Order`](https://shopify.dev/docs/api/storefront/current/objects/Order), summarizing the state of all line items. Used for display purposes.
|
|
6288
|
+
*
|
|
6289
|
+
* Statuses range from unfulfilled to fully fulfilled, with intermediate states such as in progress and on hold.
|
|
6290
|
+
*
|
|
6291
|
+
* Learn more about [order statuses](https://help.shopify.com/manual/fulfillment/managing-orders/order-status).
|
|
6292
|
+
*
|
|
6293
|
+
*/
|
|
5782
6294
|
export declare enum OrderFulfillmentStatus {
|
|
5783
6295
|
/** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */
|
|
5784
6296
|
Fulfilled = "FULFILLED",
|
|
@@ -5858,7 +6370,12 @@ export declare enum OrderSortKeys {
|
|
|
5858
6370
|
/** Sort by the `total_price` value. */
|
|
5859
6371
|
TotalPrice = "TOTAL_PRICE"
|
|
5860
6372
|
}
|
|
5861
|
-
/**
|
|
6373
|
+
/**
|
|
6374
|
+
* A [custom content page](https://help.shopify.com/manual/online-store/add-edit-pages) on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.
|
|
6375
|
+
*
|
|
6376
|
+
* Each page has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Page#field-Page.fields.handle) for URL routing and includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information for search engine optimization. Pages support [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) attachments for storing additional custom data.
|
|
6377
|
+
*
|
|
6378
|
+
*/
|
|
5862
6379
|
export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & {
|
|
5863
6380
|
__typename?: 'Page';
|
|
5864
6381
|
/** The description of the page, complete with HTML formatting. */
|
|
@@ -5886,12 +6403,22 @@ export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & {
|
|
|
5886
6403
|
/** The timestamp of the latest page update. */
|
|
5887
6404
|
updatedAt: Scalars['DateTime']['output'];
|
|
5888
6405
|
};
|
|
5889
|
-
/**
|
|
6406
|
+
/**
|
|
6407
|
+
* A [custom content page](https://help.shopify.com/manual/online-store/add-edit-pages) on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.
|
|
6408
|
+
*
|
|
6409
|
+
* Each page has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Page#field-Page.fields.handle) for URL routing and includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information for search engine optimization. Pages support [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) attachments for storing additional custom data.
|
|
6410
|
+
*
|
|
6411
|
+
*/
|
|
5890
6412
|
export type PageMetafieldArgs = {
|
|
5891
6413
|
key: Scalars['String']['input'];
|
|
5892
6414
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
5893
6415
|
};
|
|
5894
|
-
/**
|
|
6416
|
+
/**
|
|
6417
|
+
* A [custom content page](https://help.shopify.com/manual/online-store/add-edit-pages) on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.
|
|
6418
|
+
*
|
|
6419
|
+
* Each page has a unique [`handle`](https://shopify.dev/docs/api/storefront/current/objects/Page#field-Page.fields.handle) for URL routing and includes [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information for search engine optimization. Pages support [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) attachments for storing additional custom data.
|
|
6420
|
+
*
|
|
6421
|
+
*/
|
|
5895
6422
|
export type PageMetafieldsArgs = {
|
|
5896
6423
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
5897
6424
|
};
|
|
@@ -5993,8 +6520,7 @@ export declare enum PredictiveSearchLimitScope {
|
|
|
5993
6520
|
Each = "EACH"
|
|
5994
6521
|
}
|
|
5995
6522
|
/**
|
|
5996
|
-
*
|
|
5997
|
-
* that matches the predictive search query.
|
|
6523
|
+
* Returned by the [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) query to power type-ahead search experiences. Includes matching [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), [`Page`](https://shopify.dev/docs/api/storefront/current/objects/Page), and [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects, along with query suggestions that help customers refine their search.
|
|
5998
6524
|
*
|
|
5999
6525
|
*/
|
|
6000
6526
|
export type PredictiveSearchResult = {
|
|
@@ -6033,7 +6559,9 @@ export declare enum PreferenceDeliveryMethodType {
|
|
|
6033
6559
|
Shipping = "SHIPPING"
|
|
6034
6560
|
}
|
|
6035
6561
|
/**
|
|
6036
|
-
*
|
|
6562
|
+
* A price range for filtering products in a collection. Used by the [`ProductFilter`](https://shopify.dev/docs/api/storefront/current/input-objects/ProductFilter) input's [`price`](https://shopify.dev/docs/api/storefront/current/input-objects/ProductFilter#fields-price) field.
|
|
6563
|
+
*
|
|
6564
|
+
* > Note: Omitting the [maximum](https://shopify.dev/docs/api/storefront/currents/input-objects/PriceRangeFilter#fields-max) returns all products above the [minimum](https://shopify.dev/docs/api/storefront/current/input-objects/PriceRangeFilter#fields-min).
|
|
6037
6565
|
*
|
|
6038
6566
|
*/
|
|
6039
6567
|
export type PriceRangeFilter = {
|
|
@@ -6042,7 +6570,10 @@ export type PriceRangeFilter = {
|
|
|
6042
6570
|
/** The minimum price in the range. Defaults to zero. */
|
|
6043
6571
|
min?: InputMaybe<Scalars['Float']['input']>;
|
|
6044
6572
|
};
|
|
6045
|
-
/**
|
|
6573
|
+
/**
|
|
6574
|
+
* A percentage discount value applied to cart items or orders. Returned as part of the [`PricingValue`](https://shopify.dev/docs/api/storefront/current/unions/PricingValue) union on [discount applications](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication), where it represents discounts calculated as a percentage off rather than a [fixed amount](https://shopify.dev/docs/api/storefront/current/objects/MoneyV2).
|
|
6575
|
+
*
|
|
6576
|
+
*/
|
|
6046
6577
|
export type PricingPercentageValue = {
|
|
6047
6578
|
__typename?: 'PricingPercentageValue';
|
|
6048
6579
|
/** The percentage value of the object. */
|
|
@@ -6051,16 +6582,13 @@ export type PricingPercentageValue = {
|
|
|
6051
6582
|
/** The price value (fixed or percentage) for a discount application. */
|
|
6052
6583
|
export type PricingValue = MoneyV2 | PricingPercentageValue;
|
|
6053
6584
|
/**
|
|
6054
|
-
*
|
|
6585
|
+
* Represents an item listed in a shop's catalog.
|
|
6055
6586
|
*
|
|
6056
|
-
* Products
|
|
6057
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6058
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6059
|
-
* to create or update different versions of the same product.
|
|
6060
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6061
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6587
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6062
6588
|
*
|
|
6063
|
-
*
|
|
6589
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6590
|
+
*
|
|
6591
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6064
6592
|
*
|
|
6065
6593
|
*/
|
|
6066
6594
|
export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable & {
|
|
@@ -6269,16 +6797,13 @@ export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable
|
|
|
6269
6797
|
vendor: Scalars['String']['output'];
|
|
6270
6798
|
};
|
|
6271
6799
|
/**
|
|
6272
|
-
*
|
|
6800
|
+
* Represents an item listed in a shop's catalog.
|
|
6801
|
+
*
|
|
6802
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6273
6803
|
*
|
|
6274
|
-
* Products
|
|
6275
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6276
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6277
|
-
* to create or update different versions of the same product.
|
|
6278
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6279
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6804
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6280
6805
|
*
|
|
6281
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6806
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6282
6807
|
*
|
|
6283
6808
|
*/
|
|
6284
6809
|
export type ProductAdjacentVariantsArgs = {
|
|
@@ -6287,16 +6812,13 @@ export type ProductAdjacentVariantsArgs = {
|
|
|
6287
6812
|
selectedOptions?: InputMaybe<Array<SelectedOptionInput>>;
|
|
6288
6813
|
};
|
|
6289
6814
|
/**
|
|
6290
|
-
*
|
|
6815
|
+
* Represents an item listed in a shop's catalog.
|
|
6291
6816
|
*
|
|
6292
|
-
* Products
|
|
6293
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6294
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6295
|
-
* to create or update different versions of the same product.
|
|
6296
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6297
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6817
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6298
6818
|
*
|
|
6299
|
-
*
|
|
6819
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6820
|
+
*
|
|
6821
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6300
6822
|
*
|
|
6301
6823
|
*/
|
|
6302
6824
|
export type ProductCollectionsArgs = {
|
|
@@ -6307,32 +6829,26 @@ export type ProductCollectionsArgs = {
|
|
|
6307
6829
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
6308
6830
|
};
|
|
6309
6831
|
/**
|
|
6310
|
-
*
|
|
6832
|
+
* Represents an item listed in a shop's catalog.
|
|
6833
|
+
*
|
|
6834
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6311
6835
|
*
|
|
6312
|
-
* Products
|
|
6313
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6314
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6315
|
-
* to create or update different versions of the same product.
|
|
6316
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6317
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6836
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6318
6837
|
*
|
|
6319
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6838
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6320
6839
|
*
|
|
6321
6840
|
*/
|
|
6322
6841
|
export type ProductDescriptionArgs = {
|
|
6323
6842
|
truncateAt?: InputMaybe<Scalars['Int']['input']>;
|
|
6324
6843
|
};
|
|
6325
6844
|
/**
|
|
6326
|
-
*
|
|
6845
|
+
* Represents an item listed in a shop's catalog.
|
|
6327
6846
|
*
|
|
6328
|
-
* Products
|
|
6329
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6330
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6331
|
-
* to create or update different versions of the same product.
|
|
6332
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6333
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6847
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6334
6848
|
*
|
|
6335
|
-
*
|
|
6849
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6850
|
+
*
|
|
6851
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6336
6852
|
*
|
|
6337
6853
|
*/
|
|
6338
6854
|
export type ProductImagesArgs = {
|
|
@@ -6344,16 +6860,13 @@ export type ProductImagesArgs = {
|
|
|
6344
6860
|
sortKey?: InputMaybe<ProductImageSortKeys>;
|
|
6345
6861
|
};
|
|
6346
6862
|
/**
|
|
6347
|
-
*
|
|
6863
|
+
* Represents an item listed in a shop's catalog.
|
|
6864
|
+
*
|
|
6865
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6348
6866
|
*
|
|
6349
|
-
* Products
|
|
6350
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6351
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6352
|
-
* to create or update different versions of the same product.
|
|
6353
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6354
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6867
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6355
6868
|
*
|
|
6356
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6869
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6357
6870
|
*
|
|
6358
6871
|
*/
|
|
6359
6872
|
export type ProductMediaArgs = {
|
|
@@ -6365,16 +6878,13 @@ export type ProductMediaArgs = {
|
|
|
6365
6878
|
sortKey?: InputMaybe<ProductMediaSortKeys>;
|
|
6366
6879
|
};
|
|
6367
6880
|
/**
|
|
6368
|
-
*
|
|
6881
|
+
* Represents an item listed in a shop's catalog.
|
|
6369
6882
|
*
|
|
6370
|
-
* Products
|
|
6371
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6372
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6373
|
-
* to create or update different versions of the same product.
|
|
6374
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6375
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6883
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6376
6884
|
*
|
|
6377
|
-
*
|
|
6885
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6886
|
+
*
|
|
6887
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6378
6888
|
*
|
|
6379
6889
|
*/
|
|
6380
6890
|
export type ProductMetafieldArgs = {
|
|
@@ -6382,48 +6892,39 @@ export type ProductMetafieldArgs = {
|
|
|
6382
6892
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
6383
6893
|
};
|
|
6384
6894
|
/**
|
|
6385
|
-
*
|
|
6895
|
+
* Represents an item listed in a shop's catalog.
|
|
6896
|
+
*
|
|
6897
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6386
6898
|
*
|
|
6387
|
-
* Products
|
|
6388
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6389
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6390
|
-
* to create or update different versions of the same product.
|
|
6391
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6392
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6899
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6393
6900
|
*
|
|
6394
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6901
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6395
6902
|
*
|
|
6396
6903
|
*/
|
|
6397
6904
|
export type ProductMetafieldsArgs = {
|
|
6398
6905
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
6399
6906
|
};
|
|
6400
6907
|
/**
|
|
6401
|
-
*
|
|
6908
|
+
* Represents an item listed in a shop's catalog.
|
|
6402
6909
|
*
|
|
6403
|
-
* Products
|
|
6404
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6405
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6406
|
-
* to create or update different versions of the same product.
|
|
6407
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6408
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6910
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6409
6911
|
*
|
|
6410
|
-
*
|
|
6912
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6913
|
+
*
|
|
6914
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6411
6915
|
*
|
|
6412
6916
|
*/
|
|
6413
6917
|
export type ProductOptionsArgs = {
|
|
6414
6918
|
first?: InputMaybe<Scalars['Int']['input']>;
|
|
6415
6919
|
};
|
|
6416
6920
|
/**
|
|
6417
|
-
*
|
|
6921
|
+
* Represents an item listed in a shop's catalog.
|
|
6922
|
+
*
|
|
6923
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6418
6924
|
*
|
|
6419
|
-
* Products
|
|
6420
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6421
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6422
|
-
* to create or update different versions of the same product.
|
|
6423
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6424
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6925
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6425
6926
|
*
|
|
6426
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6927
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6427
6928
|
*
|
|
6428
6929
|
*/
|
|
6429
6930
|
export type ProductSelectedOrFirstAvailableVariantArgs = {
|
|
@@ -6432,16 +6933,13 @@ export type ProductSelectedOrFirstAvailableVariantArgs = {
|
|
|
6432
6933
|
selectedOptions?: InputMaybe<Array<SelectedOptionInput>>;
|
|
6433
6934
|
};
|
|
6434
6935
|
/**
|
|
6435
|
-
*
|
|
6936
|
+
* Represents an item listed in a shop's catalog.
|
|
6436
6937
|
*
|
|
6437
|
-
* Products
|
|
6438
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6439
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6440
|
-
* to create or update different versions of the same product.
|
|
6441
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6442
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6938
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6443
6939
|
*
|
|
6444
|
-
*
|
|
6940
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6941
|
+
*
|
|
6942
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6445
6943
|
*
|
|
6446
6944
|
*/
|
|
6447
6945
|
export type ProductSellingPlanGroupsArgs = {
|
|
@@ -6452,16 +6950,13 @@ export type ProductSellingPlanGroupsArgs = {
|
|
|
6452
6950
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
6453
6951
|
};
|
|
6454
6952
|
/**
|
|
6455
|
-
*
|
|
6953
|
+
* Represents an item listed in a shop's catalog.
|
|
6954
|
+
*
|
|
6955
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6456
6956
|
*
|
|
6457
|
-
* Products
|
|
6458
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6459
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6460
|
-
* to create or update different versions of the same product.
|
|
6461
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6462
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6957
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6463
6958
|
*
|
|
6464
|
-
* Learn more about working with [products and collections](/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6959
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6465
6960
|
*
|
|
6466
6961
|
*/
|
|
6467
6962
|
export type ProductVariantBySelectedOptionsArgs = {
|
|
@@ -6470,16 +6965,13 @@ export type ProductVariantBySelectedOptionsArgs = {
|
|
|
6470
6965
|
selectedOptions: Array<SelectedOptionInput>;
|
|
6471
6966
|
};
|
|
6472
6967
|
/**
|
|
6473
|
-
*
|
|
6968
|
+
* Represents an item listed in a shop's catalog.
|
|
6474
6969
|
*
|
|
6475
|
-
* Products
|
|
6476
|
-
* They can include various details such as title, description, price, images, and options such as size or color.
|
|
6477
|
-
* You can use [product variants](/docs/api/storefront/latest/objects/ProductVariant)
|
|
6478
|
-
* to create or update different versions of the same product.
|
|
6479
|
-
* You can also add or update product [media](/docs/api/storefront/latest/interfaces/Media).
|
|
6480
|
-
* Products can be organized by grouping them into a [collection](/docs/api/storefront/latest/objects/Collection).
|
|
6970
|
+
* Products support multiple [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), representing different versions of the same product, and can include various [media](https://shopify.dev/docs/api/storefront/current/interfaces/Media) types. Use the [`selectedOrFirstAvailableVariant`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.selectedOrFirstAvailableVariant) or [`variantBySelectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/Product#field-Product.fields.variantBySelectedOptions) fields to help customers find the right variant based on their selections.
|
|
6481
6971
|
*
|
|
6482
|
-
*
|
|
6972
|
+
* Products can be organized into [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), associated with [selling plans](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) for subscriptions, and extended with custom data through [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield).
|
|
6973
|
+
*
|
|
6974
|
+
* Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections).
|
|
6483
6975
|
*
|
|
6484
6976
|
*/
|
|
6485
6977
|
export type ProductVariantsArgs = {
|
|
@@ -6490,7 +6982,12 @@ export type ProductVariantsArgs = {
|
|
|
6490
6982
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
6491
6983
|
sortKey?: InputMaybe<ProductVariantSortKeys>;
|
|
6492
6984
|
};
|
|
6493
|
-
/**
|
|
6985
|
+
/**
|
|
6986
|
+
* Sort options for products within a [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection). Used by the [`products`](https://shopify.dev/docs/api/storefront/current/objects/Collection#field-Collection.fields.products) connection to order results by best-selling, price, title, creation date, or the collection's default and manual ordering.
|
|
6987
|
+
*
|
|
6988
|
+
* > Note: The [`RELEVANCE`](https://shopify.dev/docs/api/storefront/current/enums/ProductCollectionSortKeys#enums-RELEVANCE) key applies only when you specify a search query.
|
|
6989
|
+
*
|
|
6990
|
+
*/
|
|
6494
6991
|
export declare enum ProductCollectionSortKeys {
|
|
6495
6992
|
/** Sort by the `best-selling` value. */
|
|
6496
6993
|
BestSelling = "BEST_SELLING",
|
|
@@ -6596,9 +7093,11 @@ export declare enum ProductMediaSortKeys {
|
|
|
6596
7093
|
Relevance = "RELEVANCE"
|
|
6597
7094
|
}
|
|
6598
7095
|
/**
|
|
6599
|
-
*
|
|
6600
|
-
*
|
|
6601
|
-
*
|
|
7096
|
+
* A customizable product attribute that customers select when purchasing, such as "Size", "Color", or "Material". Each option has a name and a set of [`ProductOptionValue`](https://shopify.dev/docs/api/storefront/current/objects/ProductOptionValue) objects representing the available choices.
|
|
7097
|
+
*
|
|
7098
|
+
* Different combinations of option values create distinct [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) objects. Option values can include visual swatches that display colors or images to help customers make selections. Option names have a 255-character limit.
|
|
7099
|
+
*
|
|
7100
|
+
* Learn more about [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
6602
7101
|
*
|
|
6603
7102
|
*/
|
|
6604
7103
|
export type ProductOption = Node & {
|
|
@@ -6616,7 +7115,11 @@ export type ProductOption = Node & {
|
|
|
6616
7115
|
values: Array<Scalars['String']['output']>;
|
|
6617
7116
|
};
|
|
6618
7117
|
/**
|
|
6619
|
-
*
|
|
7118
|
+
* A specific value for a [`ProductOption`](https://shopify.dev/docs/api/storefront/current/objects/ProductOption), such as "Red" or "Blue" for a "Color" option. Option values combine across different options to create [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) objects.
|
|
7119
|
+
*
|
|
7120
|
+
* Each value can include a visual swatch that displays a color or image. The [`firstSelectableVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductOptionValue#field-ProductOptionValue.fields.firstSelectableVariant) field returns the variant that combines this option value with the lowest-position values for all other options. This is useful for building product selection interfaces.
|
|
7121
|
+
*
|
|
7122
|
+
* Learn more about [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
6620
7123
|
*
|
|
6621
7124
|
*/
|
|
6622
7125
|
export type ProductOptionValue = Node & {
|
|
@@ -6637,7 +7140,7 @@ export type ProductOptionValue = Node & {
|
|
|
6637
7140
|
swatch?: Maybe<ProductOptionValueSwatch>;
|
|
6638
7141
|
};
|
|
6639
7142
|
/**
|
|
6640
|
-
*
|
|
7143
|
+
* A visual representation for a [`ProductOptionValue`](https://shopify.dev/docs/api/storefront/current/objects/ProductOptionValue), such as a color or image. Swatches help customers visualize options like "Red" or "Blue" without relying solely on text labels.
|
|
6641
7144
|
*
|
|
6642
7145
|
*/
|
|
6643
7146
|
export type ProductOptionValueSwatch = {
|
|
@@ -6669,7 +7172,12 @@ export declare enum ProductRecommendationIntent {
|
|
|
6669
7172
|
/** Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section. */
|
|
6670
7173
|
Related = "RELATED"
|
|
6671
7174
|
}
|
|
6672
|
-
/**
|
|
7175
|
+
/**
|
|
7176
|
+
* Sorting options for the [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) query. Supports sorting products by criteria such as best-selling and price, and by product attributes such as type, and vendor.
|
|
7177
|
+
*
|
|
7178
|
+
* > Note: Use the [`RELEVANCE`](https://shopify.dev/docs/api/storefront/current/enums/ProductSortKeys#enums-RELEVANCE) key only when a search query is specified.
|
|
7179
|
+
*
|
|
7180
|
+
*/
|
|
6673
7181
|
export declare enum ProductSortKeys {
|
|
6674
7182
|
/** Sort by the `best_selling` value. */
|
|
6675
7183
|
BestSelling = "BEST_SELLING",
|
|
@@ -6695,7 +7203,11 @@ export declare enum ProductSortKeys {
|
|
|
6695
7203
|
Vendor = "VENDOR"
|
|
6696
7204
|
}
|
|
6697
7205
|
/**
|
|
6698
|
-
* A product
|
|
7206
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7207
|
+
*
|
|
7208
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7209
|
+
*
|
|
7210
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6699
7211
|
*
|
|
6700
7212
|
*/
|
|
6701
7213
|
export type ProductVariant = HasMetafields & Node & {
|
|
@@ -6778,7 +7290,11 @@ export type ProductVariant = HasMetafields & Node & {
|
|
|
6778
7290
|
weightUnit: WeightUnit;
|
|
6779
7291
|
};
|
|
6780
7292
|
/**
|
|
6781
|
-
* A product
|
|
7293
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7294
|
+
*
|
|
7295
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7296
|
+
*
|
|
7297
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6782
7298
|
*
|
|
6783
7299
|
*/
|
|
6784
7300
|
export type ProductVariantComponentsArgs = {
|
|
@@ -6788,7 +7304,11 @@ export type ProductVariantComponentsArgs = {
|
|
|
6788
7304
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
6789
7305
|
};
|
|
6790
7306
|
/**
|
|
6791
|
-
* A product
|
|
7307
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7308
|
+
*
|
|
7309
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7310
|
+
*
|
|
7311
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6792
7312
|
*
|
|
6793
7313
|
*/
|
|
6794
7314
|
export type ProductVariantGroupedByArgs = {
|
|
@@ -6798,7 +7318,11 @@ export type ProductVariantGroupedByArgs = {
|
|
|
6798
7318
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
6799
7319
|
};
|
|
6800
7320
|
/**
|
|
6801
|
-
* A product
|
|
7321
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7322
|
+
*
|
|
7323
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7324
|
+
*
|
|
7325
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6802
7326
|
*
|
|
6803
7327
|
*/
|
|
6804
7328
|
export type ProductVariantMetafieldArgs = {
|
|
@@ -6806,14 +7330,22 @@ export type ProductVariantMetafieldArgs = {
|
|
|
6806
7330
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
6807
7331
|
};
|
|
6808
7332
|
/**
|
|
6809
|
-
* A product
|
|
7333
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7334
|
+
*
|
|
7335
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7336
|
+
*
|
|
7337
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6810
7338
|
*
|
|
6811
7339
|
*/
|
|
6812
7340
|
export type ProductVariantMetafieldsArgs = {
|
|
6813
7341
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
6814
7342
|
};
|
|
6815
7343
|
/**
|
|
6816
|
-
* A product
|
|
7344
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7345
|
+
*
|
|
7346
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7347
|
+
*
|
|
7348
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6817
7349
|
*
|
|
6818
7350
|
*/
|
|
6819
7351
|
export type ProductVariantQuantityPriceBreaksArgs = {
|
|
@@ -6823,7 +7355,11 @@ export type ProductVariantQuantityPriceBreaksArgs = {
|
|
|
6823
7355
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
6824
7356
|
};
|
|
6825
7357
|
/**
|
|
6826
|
-
* A product
|
|
7358
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7359
|
+
*
|
|
7360
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7361
|
+
*
|
|
7362
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6827
7363
|
*
|
|
6828
7364
|
*/
|
|
6829
7365
|
export type ProductVariantSellingPlanAllocationsArgs = {
|
|
@@ -6834,7 +7370,11 @@ export type ProductVariantSellingPlanAllocationsArgs = {
|
|
|
6834
7370
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
6835
7371
|
};
|
|
6836
7372
|
/**
|
|
6837
|
-
* A product
|
|
7373
|
+
* A specific version of a [product](https://shopify.dev/docs/api/storefront/current/objects/Product) available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on [Shopify's product model](https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections).
|
|
7374
|
+
*
|
|
7375
|
+
* For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.
|
|
7376
|
+
*
|
|
7377
|
+
* Variants also support subscriptions and pre-orders through [selling plan allocations](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanAllocation) objects, bundle configurations through [product variant components](https://shopify.dev/docs/api/storefront/current/objects/ProductVariantComponent) objects, and [shop pay installments pricing](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) for flexible payment options.
|
|
6838
7378
|
*
|
|
6839
7379
|
*/
|
|
6840
7380
|
export type ProductVariantStoreAvailabilityArgs = {
|
|
@@ -6846,7 +7386,9 @@ export type ProductVariantStoreAvailabilityArgs = {
|
|
|
6846
7386
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
6847
7387
|
};
|
|
6848
7388
|
/**
|
|
6849
|
-
*
|
|
7389
|
+
* An individual product variant included in a [fixed bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles). Fixed bundles group multiple products together and sell them as a single unit, with the bundle's inventory determined by its components.
|
|
7390
|
+
*
|
|
7391
|
+
* Access components through the `ProductVariant` object's [`components`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant#field-ProductVariant.fields.components) field.
|
|
6850
7392
|
*
|
|
6851
7393
|
*/
|
|
6852
7394
|
export type ProductVariantComponent = {
|
|
@@ -7001,25 +7543,48 @@ export type QuantityRule = {
|
|
|
7001
7543
|
*/
|
|
7002
7544
|
minimum: Scalars['Int']['output'];
|
|
7003
7545
|
};
|
|
7004
|
-
/**
|
|
7546
|
+
/**
|
|
7547
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7548
|
+
*
|
|
7549
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7550
|
+
*
|
|
7551
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7552
|
+
*
|
|
7553
|
+
*/
|
|
7005
7554
|
export type QueryRoot = {
|
|
7006
7555
|
__typename?: 'QueryRoot';
|
|
7007
|
-
/**
|
|
7556
|
+
/**
|
|
7557
|
+
* Returns an [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) by its ID. Each article belongs to a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) and includes content in both plain text and HTML formats, [`ArticleAuthor`](https://shopify.dev/docs/api/storefront/current/objects/ArticleAuthor) information, [`Comment`](https://shopify.dev/docs/api/storefront/current/objects/Comment) objects, tags, and [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) data.
|
|
7558
|
+
*
|
|
7559
|
+
*/
|
|
7008
7560
|
article?: Maybe<Article>;
|
|
7009
|
-
/**
|
|
7561
|
+
/**
|
|
7562
|
+
* Returns a paginated list of [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects from the shop's [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) objects. Each article is a blog post containing content, author information, tags, and optional images.
|
|
7563
|
+
*
|
|
7564
|
+
* Use the `query` argument to filter results by author, blog title, tags, or date fields. Sort results using the `sortKey` argument and reverse them with the `reverse` argument.
|
|
7565
|
+
*
|
|
7566
|
+
*/
|
|
7010
7567
|
articles: ArticleConnection;
|
|
7011
|
-
/**
|
|
7568
|
+
/**
|
|
7569
|
+
* Retrieves a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) by its handle or ID. A blog organizes [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects for the online store and includes author information, [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) settings, and custom [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects.
|
|
7570
|
+
*
|
|
7571
|
+
*/
|
|
7012
7572
|
blog?: Maybe<Blog>;
|
|
7013
7573
|
/**
|
|
7014
|
-
*
|
|
7574
|
+
* Retrieves a [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) by its handle. A blog organizes [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects for the online store and includes author information, [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) settings, and custom [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects.
|
|
7575
|
+
*
|
|
7015
7576
|
* @deprecated Use `blog` instead.
|
|
7016
7577
|
*/
|
|
7017
7578
|
blogByHandle?: Maybe<Blog>;
|
|
7018
|
-
/**
|
|
7579
|
+
/**
|
|
7580
|
+
* Returns a paginated list of the shop's [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) objects. Each blog serves as a container for [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) objects.
|
|
7581
|
+
*
|
|
7582
|
+
*/
|
|
7019
7583
|
blogs: BlogConnection;
|
|
7020
7584
|
/**
|
|
7021
|
-
*
|
|
7022
|
-
*
|
|
7585
|
+
* Returns a [`Cart`](https://shopify.dev/docs/api/storefront/current/objects/Cart) by its ID. The cart contains the merchandise lines a buyer intends to purchase, along with estimated costs, applied discounts, gift cards, and delivery options.
|
|
7586
|
+
*
|
|
7587
|
+
* Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/latest/queries/cart#returns-Cart.fields.checkoutUrl) field to redirect buyers to Shopify's web checkout when they're ready to complete their purchase. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
|
|
7023
7588
|
*
|
|
7024
7589
|
*/
|
|
7025
7590
|
cart?: Maybe<Cart>;
|
|
@@ -7028,94 +7593,194 @@ export type QueryRoot = {
|
|
|
7028
7593
|
*
|
|
7029
7594
|
*/
|
|
7030
7595
|
cartCompletionAttempt?: Maybe<CartCompletionAttemptResult>;
|
|
7031
|
-
/**
|
|
7596
|
+
/**
|
|
7597
|
+
* Retrieves a single [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection) by its ID or handle. Use the [`products`](https://shopify.dev/docs/api/storefront/current/objects/Collection#field-Collection.fields.products) field to access items in the collection.
|
|
7598
|
+
*
|
|
7599
|
+
*/
|
|
7032
7600
|
collection?: Maybe<Collection>;
|
|
7033
7601
|
/**
|
|
7034
|
-
*
|
|
7602
|
+
* Retrieves a [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection) by its URL-friendly handle. Handles are automatically generated from collection titles but merchants can customize them.
|
|
7603
|
+
*
|
|
7035
7604
|
* @deprecated Use `collection` instead.
|
|
7036
7605
|
*/
|
|
7037
7606
|
collectionByHandle?: Maybe<Collection>;
|
|
7038
|
-
/**
|
|
7607
|
+
/**
|
|
7608
|
+
* Returns a paginated list of the shop's [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection). Each `Collection` object includes a nested connection to its [products](https://shopify.dev/docs/api/storefront/current/objects/Collection#field-Collection.fields.products).
|
|
7609
|
+
*
|
|
7610
|
+
*/
|
|
7039
7611
|
collections: CollectionConnection;
|
|
7040
7612
|
/**
|
|
7041
|
-
*
|
|
7042
|
-
*
|
|
7613
|
+
* Retrieves the [`Customer`](https://shopify.dev/docs/api/storefront/current/objects/Customer) associated with the provided access token. Use the [`customerAccessTokenCreate`](https://shopify.dev/docs/api/storefront/current/mutations/customerAccessTokenCreate) mutation to obtain an access token using legacy customer account authentication (email and password).
|
|
7614
|
+
*
|
|
7615
|
+
* The returned customer includes data such as contact information, [addresses](https://shopify.dev/docs/api/storefront/current/objects/MailingAddress), [orders](https://shopify.dev/docs/api/storefront/current/objects/Order), and [custom data](https://shopify.dev/docs/apps/build/custom-data) associated with the customer.
|
|
7043
7616
|
*
|
|
7044
7617
|
*/
|
|
7045
7618
|
customer?: Maybe<Customer>;
|
|
7046
|
-
/**
|
|
7619
|
+
/**
|
|
7620
|
+
* Returns the shop's localization settings. Use this query to build [country and language selectors](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/markets) for your storefront.
|
|
7621
|
+
*
|
|
7622
|
+
* The [`country`](https://shopify.dev/docs/api/storefront/latest/queries/localization#returns-Localization.fields.country) and [`language`](https://shopify.dev/docs/api/storefront/latest/queries/localization#returns-Localization.fields.language) fields reflect the active localized experience. To change the context, use the [`@inContext`](https://shopify.dev/docs/api/storefront#directives) directive with your desired country or language code.
|
|
7623
|
+
*
|
|
7624
|
+
*/
|
|
7047
7625
|
localization: Localization;
|
|
7048
7626
|
/**
|
|
7049
|
-
*
|
|
7627
|
+
* Returns shop locations that support in-store pickup. Use the `near` argument with [`GeoCoordinateInput`](https://shopify.dev/docs/api/storefront/current/input-objects/GeoCoordinateInput) to sort results by proximity to the customer's location.
|
|
7050
7628
|
*
|
|
7051
|
-
* When sorting by distance,
|
|
7629
|
+
* When sorting by distance, set `sortKey` to [`DISTANCE`](https://shopify.dev/docs/api/storefront/current/queries/locations#arguments-sortKey.enums.DISTANCE) and provide coordinates using the [`near`](https://shopify.dev/docs/api/storefront/current/queries/locations#arguments-near) argument.
|
|
7052
7630
|
*
|
|
7631
|
+
* Learn more about [supporting local pickup on storefronts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/local-pickup).
|
|
7053
7632
|
*
|
|
7054
7633
|
*/
|
|
7055
7634
|
locations: LocationConnection;
|
|
7056
|
-
/**
|
|
7057
|
-
|
|
7058
|
-
|
|
7059
|
-
|
|
7060
|
-
|
|
7635
|
+
/**
|
|
7636
|
+
* Retrieves a [`Menu`](https://shopify.dev/docs/api/storefront/current/objects/Menu) by its handle. Menus are [hierarchical navigation structures](https://help.shopify.com/manual/online-store/menus-and-links) that merchants configure for their storefront, such as header and footer navigation.
|
|
7637
|
+
*
|
|
7638
|
+
* Each menu contains [`MenuItem`](https://shopify.dev/docs/api/storefront/current/objects/MenuItem) objects that can nest up to three levels deep, with each item linking to [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), [products](https://shopify.dev/docs/api/storefront/current/objects/Product), [pages](https://shopify.dev/docs/api/storefront/current/objects/Page), [blogs](https://shopify.dev/docs/api/storefront/current/objects/Blog), or external URLs.
|
|
7639
|
+
*
|
|
7640
|
+
*/
|
|
7641
|
+
menu?: Maybe<Menu>;
|
|
7642
|
+
/**
|
|
7643
|
+
* Retrieves a single [`Metaobject`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject) by either its [`global ID`](https://shopify.dev/docs/api/storefront/current/queries/metaobject#arguments-id) or its [`handle`](https://shopify.dev/docs/api/storefront/current/queries/metaobject#arguments-handle).
|
|
7644
|
+
*
|
|
7645
|
+
* > Note:
|
|
7646
|
+
* > When using the handle, you must also provide the metaobject type because handles are only unique within a type.
|
|
7647
|
+
*
|
|
7648
|
+
*/
|
|
7649
|
+
metaobject?: Maybe<Metaobject>;
|
|
7650
|
+
/**
|
|
7651
|
+
* Returns a paginated list of [`Metaobject`](https://shopify.dev/docs/api/storefront/current/objects/Metaobject) entries for a specific type. Metaobjects are [custom data structures](https://shopify.dev/docs/apps/build/metaobjects) that extend Shopify's data model with merchant-defined or app-defined content like size charts, product highlights, or custom sections.
|
|
7652
|
+
*
|
|
7653
|
+
* The required `type` argument specifies which metaobject type to retrieve. You can sort results by `id` or `updated_at` using the `sortKey` argument.
|
|
7654
|
+
*
|
|
7655
|
+
*/
|
|
7061
7656
|
metaobjects: MetaobjectConnection;
|
|
7062
|
-
/**
|
|
7657
|
+
/**
|
|
7658
|
+
* Retrieves any object that implements the [`Node`](https://shopify.dev/docs/api/storefront/current/interfaces/Node) interface by its globally-unique ID. Use inline fragments to access type-specific fields on the returned object.
|
|
7659
|
+
*
|
|
7660
|
+
* This query follows the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface) and is commonly used for refetching objects when you have their ID but need updated data.
|
|
7661
|
+
*
|
|
7662
|
+
*/
|
|
7063
7663
|
node?: Maybe<Node>;
|
|
7064
|
-
/**
|
|
7664
|
+
/**
|
|
7665
|
+
* Retrieves multiple objects by their global IDs in a single request. Any object that implements the [`Node`](https://shopify.dev/docs/api/storefront/current/interfaces/Node) interface can be fetched, including [products](https://shopify.dev/docs/api/storefront/current/objects/Product), [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), and [pages](https://shopify.dev/docs/api/storefront/current/objects/Page).
|
|
7666
|
+
*
|
|
7667
|
+
* Use inline fragments to access type-specific fields on the returned objects. The input accepts up to 250 IDs.
|
|
7668
|
+
*
|
|
7669
|
+
*/
|
|
7065
7670
|
nodes: Array<Maybe<Node>>;
|
|
7066
|
-
/**
|
|
7671
|
+
/**
|
|
7672
|
+
* Retrieves a [`Page`](https://shopify.dev/docs/api/storefront/current/objects/Page) by its [`handle`](https://shopify.dev/docs/api/storefront/current/queries/page#arguments-handle) or [`id`](https://shopify.dev/docs/api/storefront/current/queries/page#arguments-id). Pages are static content pages that merchants display outside their product catalog, such as "About Us," "Contact," or policy pages.
|
|
7673
|
+
*
|
|
7674
|
+
* The returned page includes information such as the [HTML body content](https://shopify.dev/docs/api/storefront/current/queries/page#returns-Page.fields.body), [`SEO`](https://shopify.dev/docs/api/storefront/current/objects/SEO) information, and any associated [`Metafield`](https://shopify.dev/docs/api/storefront/current/objects/Metafield) objects.
|
|
7675
|
+
*
|
|
7676
|
+
*/
|
|
7067
7677
|
page?: Maybe<Page>;
|
|
7068
7678
|
/**
|
|
7069
|
-
*
|
|
7679
|
+
* Retrieves a [`Page`](https://shopify.dev/docs/api/storefront/current/objects/Page) by its handle.
|
|
7680
|
+
*
|
|
7070
7681
|
* @deprecated Use `page` instead.
|
|
7071
7682
|
*/
|
|
7072
7683
|
pageByHandle?: Maybe<Page>;
|
|
7073
|
-
/**
|
|
7684
|
+
/**
|
|
7685
|
+
* Returns a paginated list of the shop's content [pages](https://shopify.dev/docs/api/storefront/current/objects/Page). Pages are custom HTML content like "About Us", "Contact", or policy information that merchants display outside their product catalog.
|
|
7686
|
+
*
|
|
7687
|
+
*/
|
|
7074
7688
|
pages: PageConnection;
|
|
7075
7689
|
/** Settings related to payments. */
|
|
7076
7690
|
paymentSettings: PaymentSettings;
|
|
7077
|
-
/**
|
|
7691
|
+
/**
|
|
7692
|
+
* Returns suggested results as customers type in a search field, enabling type-ahead search experiences. The query matches [products](https://shopify.dev/docs/api/storefront/current/objects/Product), [collections](https://shopify.dev/docs/api/storefront/current/objects/Collection), [pages](https://shopify.dev/docs/api/storefront/current/objects/Page), and [articles](https://shopify.dev/docs/api/storefront/current/objects/Article) based on partial search terms, and also provides [search query suggestions](https://shopify.dev/docs/api/storefront/current/objects/SearchQuerySuggestion) to help customers refine their search.
|
|
7693
|
+
*
|
|
7694
|
+
* You can filter results by resource type and limit the quantity. The [`limitScope`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch#arguments-limitScope) argument controls whether limits apply across all result types or per type. Use [`unavailableProducts`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch#arguments-unavailableProducts) to control how out-of-stock products appear in results.
|
|
7695
|
+
*
|
|
7696
|
+
*/
|
|
7078
7697
|
predictiveSearch?: Maybe<PredictiveSearchResult>;
|
|
7079
|
-
/**
|
|
7698
|
+
/**
|
|
7699
|
+
* Retrieves a single [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product) by its ID or handle. Use this query to build product detail pages, access variant and pricing information, or fetch product media and [metafields](https://shopify.dev/docs/api/storefront/current/objects/Metafield). See some [examples of querying products](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/getting-started).
|
|
7700
|
+
*
|
|
7701
|
+
*/
|
|
7080
7702
|
product?: Maybe<Product>;
|
|
7081
7703
|
/**
|
|
7082
|
-
*
|
|
7704
|
+
* Retrieves a [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product) by its handle. The handle is a URL-friendly identifier that's automatically generated from the product's title. If no product exists with the specified handle, returns `null`.
|
|
7705
|
+
*
|
|
7083
7706
|
* @deprecated Use `product` instead.
|
|
7084
7707
|
*/
|
|
7085
7708
|
productByHandle?: Maybe<Product>;
|
|
7086
7709
|
/**
|
|
7087
|
-
*
|
|
7088
|
-
*
|
|
7089
|
-
* [
|
|
7710
|
+
* Returns recommended products for a given product, identified by either ID or handle. Use the [`intent`](https://shopify.dev/docs/api/storefront/current/enums/ProductRecommendationIntent) argument to control the recommendation strategy.
|
|
7711
|
+
*
|
|
7712
|
+
* Shopify [auto-generates related recommendations](https://shopify.dev/docs/storefronts/themes/product-merchandising/recommendations) based on sales data, product descriptions, and collection relationships. Complementary recommendations require [manual configuration](https://help.shopify.com/manual/online-store/storefront-search/search-and-discovery-recommendations) through the Shopify Search & Discovery app. Returns up to ten [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product) objects.
|
|
7090
7713
|
*
|
|
7091
7714
|
*/
|
|
7092
7715
|
productRecommendations?: Maybe<Array<Product>>;
|
|
7093
7716
|
/**
|
|
7094
|
-
*
|
|
7095
|
-
* Additional access scope required: unauthenticated_read_product_tags.
|
|
7717
|
+
* Returns a paginated list of all tags that have been added to [products](https://shopify.dev/docs/api/storefront/current/objects/Product) in the shop. Useful for building tag-based product filtering or navigation in a storefront.
|
|
7096
7718
|
*
|
|
7097
7719
|
*/
|
|
7098
7720
|
productTags: StringConnection;
|
|
7099
|
-
/**
|
|
7721
|
+
/**
|
|
7722
|
+
* Returns a list of product types from the shop's [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product) objects that are published to your app. Use this query to build [filtering interfaces](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products) or navigation menus based on product categorization.
|
|
7723
|
+
*
|
|
7724
|
+
*/
|
|
7100
7725
|
productTypes: StringConnection;
|
|
7101
|
-
/**
|
|
7726
|
+
/**
|
|
7727
|
+
* Returns a paginated list of the shop's [products](https://shopify.dev/docs/api/storefront/current/objects/Product).
|
|
7728
|
+
*
|
|
7729
|
+
* For full-text storefront search, use the [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) query instead.
|
|
7730
|
+
*
|
|
7731
|
+
*/
|
|
7102
7732
|
products: ProductConnection;
|
|
7103
|
-
/**
|
|
7733
|
+
/**
|
|
7734
|
+
* Returns all public Storefront [API versions](https://shopify.dev/docs/api/storefront/current/objects/ApiVersion), including supported, release candidate, and unstable versions.
|
|
7735
|
+
*
|
|
7736
|
+
*/
|
|
7104
7737
|
publicApiVersions: Array<ApiVersion>;
|
|
7105
|
-
/**
|
|
7738
|
+
/**
|
|
7739
|
+
* Returns paginated search results for [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Page`](https://shopify.dev/docs/api/storefront/current/objects/Page), and [`Article`](https://shopify.dev/docs/api/storefront/current/objects/Article) resources based on a query string. Results are sorted by relevance by default.
|
|
7740
|
+
*
|
|
7741
|
+
* The response includes the total result count and available product filters for building [faceted search interfaces](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/filter-products). Use the [`prefix`](https://shopify.dev/docs/api/storefront/current/enums/SearchPrefixQueryType) argument to enable partial word matching on the last search term, allowing queries like "winter snow" to match "snowboard" or "snowshoe".
|
|
7742
|
+
*
|
|
7743
|
+
*/
|
|
7106
7744
|
search: SearchResultItemConnection;
|
|
7107
|
-
/**
|
|
7745
|
+
/**
|
|
7746
|
+
* Returns the [`Shop`](https://shopify.dev/docs/api/storefront/current/objects/Shop) associated with the storefront access token. The `Shop` object provides general store information such as the shop name, description, and primary domain.
|
|
7747
|
+
*
|
|
7748
|
+
* Use this query to access data like store policies, [`PaymentSettings`](https://shopify.dev/docs/api/storefront/current/objects/PaymentSettings), [`Brand`](https://shopify.dev/docs/api/storefront/current/objects/Brand) configuration, and shipping destinations. It also exposes [`ShopPayInstallmentsPricing`](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing) and [`SocialLoginProvider`](https://shopify.dev/docs/api/storefront/current/objects/SocialLoginProvider) options for customer accounts.
|
|
7749
|
+
*
|
|
7750
|
+
*/
|
|
7108
7751
|
shop: Shop;
|
|
7109
|
-
/**
|
|
7752
|
+
/**
|
|
7753
|
+
* Returns sitemap data for a specific resource type, enabling headless storefronts to generate XML sitemaps for search engine optimization. The query provides a page count and paginated access to resources like [`Product`](https://shopify.dev/docs/api/storefront/current/objects/Product), [`Collection`](https://shopify.dev/docs/api/storefront/current/objects/Collection), [`Page`](https://shopify.dev/docs/api/storefront/current/objects/Page), and [`Blog`](https://shopify.dev/docs/api/storefront/current/objects/Blog) objects.
|
|
7754
|
+
*
|
|
7755
|
+
* When paginating through resources, the number of items per page varies from 0 to 250, and empty pages can occur without indicating the end of results. Always check [`hasNextPage`](https://shopify.dev/docs/api/storefront/current/objects/PaginatedSitemapResources#field-PaginatedSitemapResources.fields.hasNextPage) to determine if more pages are available.
|
|
7756
|
+
*
|
|
7757
|
+
*/
|
|
7110
7758
|
sitemap: Sitemap;
|
|
7111
|
-
/**
|
|
7759
|
+
/**
|
|
7760
|
+
* Returns a paginated list of [`UrlRedirect`](https://shopify.dev/docs/api/storefront/current/objects/UrlRedirect) objects configured for the shop. Each redirect maps an old path to a target location.
|
|
7761
|
+
*
|
|
7762
|
+
*/
|
|
7112
7763
|
urlRedirects: UrlRedirectConnection;
|
|
7113
7764
|
};
|
|
7114
|
-
/**
|
|
7765
|
+
/**
|
|
7766
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7767
|
+
*
|
|
7768
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7769
|
+
*
|
|
7770
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7771
|
+
*
|
|
7772
|
+
*/
|
|
7115
7773
|
export type QueryRootArticleArgs = {
|
|
7116
7774
|
id: Scalars['ID']['input'];
|
|
7117
7775
|
};
|
|
7118
|
-
/**
|
|
7776
|
+
/**
|
|
7777
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7778
|
+
*
|
|
7779
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7780
|
+
*
|
|
7781
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7782
|
+
*
|
|
7783
|
+
*/
|
|
7119
7784
|
export type QueryRootArticlesArgs = {
|
|
7120
7785
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7121
7786
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7125,16 +7790,37 @@ export type QueryRootArticlesArgs = {
|
|
|
7125
7790
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7126
7791
|
sortKey?: InputMaybe<ArticleSortKeys>;
|
|
7127
7792
|
};
|
|
7128
|
-
/**
|
|
7793
|
+
/**
|
|
7794
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7795
|
+
*
|
|
7796
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7797
|
+
*
|
|
7798
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7799
|
+
*
|
|
7800
|
+
*/
|
|
7129
7801
|
export type QueryRootBlogArgs = {
|
|
7130
7802
|
handle?: InputMaybe<Scalars['String']['input']>;
|
|
7131
7803
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
7132
7804
|
};
|
|
7133
|
-
/**
|
|
7805
|
+
/**
|
|
7806
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7807
|
+
*
|
|
7808
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7809
|
+
*
|
|
7810
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7811
|
+
*
|
|
7812
|
+
*/
|
|
7134
7813
|
export type QueryRootBlogByHandleArgs = {
|
|
7135
7814
|
handle: Scalars['String']['input'];
|
|
7136
7815
|
};
|
|
7137
|
-
/**
|
|
7816
|
+
/**
|
|
7817
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7818
|
+
*
|
|
7819
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7820
|
+
*
|
|
7821
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7822
|
+
*
|
|
7823
|
+
*/
|
|
7138
7824
|
export type QueryRootBlogsArgs = {
|
|
7139
7825
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7140
7826
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7144,24 +7830,59 @@ export type QueryRootBlogsArgs = {
|
|
|
7144
7830
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7145
7831
|
sortKey?: InputMaybe<BlogSortKeys>;
|
|
7146
7832
|
};
|
|
7147
|
-
/**
|
|
7833
|
+
/**
|
|
7834
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7835
|
+
*
|
|
7836
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7837
|
+
*
|
|
7838
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7839
|
+
*
|
|
7840
|
+
*/
|
|
7148
7841
|
export type QueryRootCartArgs = {
|
|
7149
7842
|
id: Scalars['ID']['input'];
|
|
7150
7843
|
};
|
|
7151
|
-
/**
|
|
7844
|
+
/**
|
|
7845
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7846
|
+
*
|
|
7847
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7848
|
+
*
|
|
7849
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7850
|
+
*
|
|
7851
|
+
*/
|
|
7152
7852
|
export type QueryRootCartCompletionAttemptArgs = {
|
|
7153
7853
|
attemptId: Scalars['String']['input'];
|
|
7154
7854
|
};
|
|
7155
|
-
/**
|
|
7855
|
+
/**
|
|
7856
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7857
|
+
*
|
|
7858
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7859
|
+
*
|
|
7860
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7861
|
+
*
|
|
7862
|
+
*/
|
|
7156
7863
|
export type QueryRootCollectionArgs = {
|
|
7157
7864
|
handle?: InputMaybe<Scalars['String']['input']>;
|
|
7158
7865
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
7159
7866
|
};
|
|
7160
|
-
/**
|
|
7867
|
+
/**
|
|
7868
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7869
|
+
*
|
|
7870
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7871
|
+
*
|
|
7872
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7873
|
+
*
|
|
7874
|
+
*/
|
|
7161
7875
|
export type QueryRootCollectionByHandleArgs = {
|
|
7162
7876
|
handle: Scalars['String']['input'];
|
|
7163
7877
|
};
|
|
7164
|
-
/**
|
|
7878
|
+
/**
|
|
7879
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7880
|
+
*
|
|
7881
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7882
|
+
*
|
|
7883
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7884
|
+
*
|
|
7885
|
+
*/
|
|
7165
7886
|
export type QueryRootCollectionsArgs = {
|
|
7166
7887
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7167
7888
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7171,11 +7892,25 @@ export type QueryRootCollectionsArgs = {
|
|
|
7171
7892
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7172
7893
|
sortKey?: InputMaybe<CollectionSortKeys>;
|
|
7173
7894
|
};
|
|
7174
|
-
/**
|
|
7895
|
+
/**
|
|
7896
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7897
|
+
*
|
|
7898
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7899
|
+
*
|
|
7900
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7901
|
+
*
|
|
7902
|
+
*/
|
|
7175
7903
|
export type QueryRootCustomerArgs = {
|
|
7176
7904
|
customerAccessToken: Scalars['String']['input'];
|
|
7177
7905
|
};
|
|
7178
|
-
/**
|
|
7906
|
+
/**
|
|
7907
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7908
|
+
*
|
|
7909
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7910
|
+
*
|
|
7911
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7912
|
+
*
|
|
7913
|
+
*/
|
|
7179
7914
|
export type QueryRootLocationsArgs = {
|
|
7180
7915
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7181
7916
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7185,16 +7920,37 @@ export type QueryRootLocationsArgs = {
|
|
|
7185
7920
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7186
7921
|
sortKey?: InputMaybe<LocationSortKeys>;
|
|
7187
7922
|
};
|
|
7188
|
-
/**
|
|
7923
|
+
/**
|
|
7924
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7925
|
+
*
|
|
7926
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7927
|
+
*
|
|
7928
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7929
|
+
*
|
|
7930
|
+
*/
|
|
7189
7931
|
export type QueryRootMenuArgs = {
|
|
7190
7932
|
handle: Scalars['String']['input'];
|
|
7191
7933
|
};
|
|
7192
|
-
/**
|
|
7934
|
+
/**
|
|
7935
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7936
|
+
*
|
|
7937
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7938
|
+
*
|
|
7939
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7940
|
+
*
|
|
7941
|
+
*/
|
|
7193
7942
|
export type QueryRootMetaobjectArgs = {
|
|
7194
7943
|
handle?: InputMaybe<MetaobjectHandleInput>;
|
|
7195
7944
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
7196
7945
|
};
|
|
7197
|
-
/**
|
|
7946
|
+
/**
|
|
7947
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7948
|
+
*
|
|
7949
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7950
|
+
*
|
|
7951
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7952
|
+
*
|
|
7953
|
+
*/
|
|
7198
7954
|
export type QueryRootMetaobjectsArgs = {
|
|
7199
7955
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7200
7956
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7204,24 +7960,59 @@ export type QueryRootMetaobjectsArgs = {
|
|
|
7204
7960
|
sortKey?: InputMaybe<Scalars['String']['input']>;
|
|
7205
7961
|
type: Scalars['String']['input'];
|
|
7206
7962
|
};
|
|
7207
|
-
/**
|
|
7963
|
+
/**
|
|
7964
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7965
|
+
*
|
|
7966
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7967
|
+
*
|
|
7968
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7969
|
+
*
|
|
7970
|
+
*/
|
|
7208
7971
|
export type QueryRootNodeArgs = {
|
|
7209
7972
|
id: Scalars['ID']['input'];
|
|
7210
7973
|
};
|
|
7211
|
-
/**
|
|
7974
|
+
/**
|
|
7975
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7976
|
+
*
|
|
7977
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7978
|
+
*
|
|
7979
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7980
|
+
*
|
|
7981
|
+
*/
|
|
7212
7982
|
export type QueryRootNodesArgs = {
|
|
7213
7983
|
ids: Array<Scalars['ID']['input']>;
|
|
7214
7984
|
};
|
|
7215
|
-
/**
|
|
7985
|
+
/**
|
|
7986
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7987
|
+
*
|
|
7988
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
7989
|
+
*
|
|
7990
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
7991
|
+
*
|
|
7992
|
+
*/
|
|
7216
7993
|
export type QueryRootPageArgs = {
|
|
7217
7994
|
handle?: InputMaybe<Scalars['String']['input']>;
|
|
7218
7995
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
7219
7996
|
};
|
|
7220
|
-
/**
|
|
7997
|
+
/**
|
|
7998
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
7999
|
+
*
|
|
8000
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8001
|
+
*
|
|
8002
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8003
|
+
*
|
|
8004
|
+
*/
|
|
7221
8005
|
export type QueryRootPageByHandleArgs = {
|
|
7222
8006
|
handle: Scalars['String']['input'];
|
|
7223
8007
|
};
|
|
7224
|
-
/**
|
|
8008
|
+
/**
|
|
8009
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8010
|
+
*
|
|
8011
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8012
|
+
*
|
|
8013
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8014
|
+
*
|
|
8015
|
+
*/
|
|
7225
8016
|
export type QueryRootPagesArgs = {
|
|
7226
8017
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7227
8018
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7231,7 +8022,14 @@ export type QueryRootPagesArgs = {
|
|
|
7231
8022
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7232
8023
|
sortKey?: InputMaybe<PageSortKeys>;
|
|
7233
8024
|
};
|
|
7234
|
-
/**
|
|
8025
|
+
/**
|
|
8026
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8027
|
+
*
|
|
8028
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8029
|
+
*
|
|
8030
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8031
|
+
*
|
|
8032
|
+
*/
|
|
7235
8033
|
export type QueryRootPredictiveSearchArgs = {
|
|
7236
8034
|
limit?: InputMaybe<Scalars['Int']['input']>;
|
|
7237
8035
|
limitScope?: InputMaybe<PredictiveSearchLimitScope>;
|
|
@@ -7240,30 +8038,72 @@ export type QueryRootPredictiveSearchArgs = {
|
|
|
7240
8038
|
types?: InputMaybe<Array<PredictiveSearchType>>;
|
|
7241
8039
|
unavailableProducts?: InputMaybe<SearchUnavailableProductsType>;
|
|
7242
8040
|
};
|
|
7243
|
-
/**
|
|
8041
|
+
/**
|
|
8042
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8043
|
+
*
|
|
8044
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8045
|
+
*
|
|
8046
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8047
|
+
*
|
|
8048
|
+
*/
|
|
7244
8049
|
export type QueryRootProductArgs = {
|
|
7245
8050
|
handle?: InputMaybe<Scalars['String']['input']>;
|
|
7246
8051
|
id?: InputMaybe<Scalars['ID']['input']>;
|
|
7247
8052
|
};
|
|
7248
|
-
/**
|
|
8053
|
+
/**
|
|
8054
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8055
|
+
*
|
|
8056
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8057
|
+
*
|
|
8058
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8059
|
+
*
|
|
8060
|
+
*/
|
|
7249
8061
|
export type QueryRootProductByHandleArgs = {
|
|
7250
8062
|
handle: Scalars['String']['input'];
|
|
7251
8063
|
};
|
|
7252
|
-
/**
|
|
8064
|
+
/**
|
|
8065
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8066
|
+
*
|
|
8067
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8068
|
+
*
|
|
8069
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8070
|
+
*
|
|
8071
|
+
*/
|
|
7253
8072
|
export type QueryRootProductRecommendationsArgs = {
|
|
7254
8073
|
intent?: InputMaybe<ProductRecommendationIntent>;
|
|
7255
8074
|
productHandle?: InputMaybe<Scalars['String']['input']>;
|
|
7256
8075
|
productId?: InputMaybe<Scalars['ID']['input']>;
|
|
7257
8076
|
};
|
|
7258
|
-
/**
|
|
8077
|
+
/**
|
|
8078
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8079
|
+
*
|
|
8080
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8081
|
+
*
|
|
8082
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8083
|
+
*
|
|
8084
|
+
*/
|
|
7259
8085
|
export type QueryRootProductTagsArgs = {
|
|
7260
8086
|
first: Scalars['Int']['input'];
|
|
7261
8087
|
};
|
|
7262
|
-
/**
|
|
8088
|
+
/**
|
|
8089
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8090
|
+
*
|
|
8091
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8092
|
+
*
|
|
8093
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8094
|
+
*
|
|
8095
|
+
*/
|
|
7263
8096
|
export type QueryRootProductTypesArgs = {
|
|
7264
8097
|
first: Scalars['Int']['input'];
|
|
7265
8098
|
};
|
|
7266
|
-
/**
|
|
8099
|
+
/**
|
|
8100
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8101
|
+
*
|
|
8102
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8103
|
+
*
|
|
8104
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8105
|
+
*
|
|
8106
|
+
*/
|
|
7267
8107
|
export type QueryRootProductsArgs = {
|
|
7268
8108
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7269
8109
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7273,7 +8113,14 @@ export type QueryRootProductsArgs = {
|
|
|
7273
8113
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7274
8114
|
sortKey?: InputMaybe<ProductSortKeys>;
|
|
7275
8115
|
};
|
|
7276
|
-
/**
|
|
8116
|
+
/**
|
|
8117
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8118
|
+
*
|
|
8119
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8120
|
+
*
|
|
8121
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8122
|
+
*
|
|
8123
|
+
*/
|
|
7277
8124
|
export type QueryRootSearchArgs = {
|
|
7278
8125
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7279
8126
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7287,11 +8134,25 @@ export type QueryRootSearchArgs = {
|
|
|
7287
8134
|
types?: InputMaybe<Array<SearchType>>;
|
|
7288
8135
|
unavailableProducts?: InputMaybe<SearchUnavailableProductsType>;
|
|
7289
8136
|
};
|
|
7290
|
-
/**
|
|
8137
|
+
/**
|
|
8138
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8139
|
+
*
|
|
8140
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8141
|
+
*
|
|
8142
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8143
|
+
*
|
|
8144
|
+
*/
|
|
7291
8145
|
export type QueryRootSitemapArgs = {
|
|
7292
8146
|
type: SitemapType;
|
|
7293
8147
|
};
|
|
7294
|
-
/**
|
|
8148
|
+
/**
|
|
8149
|
+
* The entry point for all Storefront API queries. Provides access to shop resources including products, collections, carts, and customer data, as well as content like articles and pages. This query acts as the public, top-level type from which all queries must start.
|
|
8150
|
+
*
|
|
8151
|
+
* Use individual queries like [`product`](https://shopify.dev/docs/api/storefront/current/queries/product) or [`collection`](https://shopify.dev/docs/api/storefront/current/queries/collection) to fetch specific resources by ID or handle. Use plural queries like [`products`](https://shopify.dev/docs/api/storefront/current/queries/products) or [`collections`](https://shopify.dev/docs/api/storefront/current/queries/collections) to retrieve paginated lists with optional filtering and sorting. The [`search`](https://shopify.dev/docs/api/storefront/current/queries/search) and [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries enable storefront search functionality.
|
|
8152
|
+
*
|
|
8153
|
+
* Explore queries interactively with the [GraphiQL explorer and sample query kit](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/api-exploration).
|
|
8154
|
+
*
|
|
8155
|
+
*/
|
|
7295
8156
|
export type QueryRootUrlRedirectsArgs = {
|
|
7296
8157
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7297
8158
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7300,7 +8161,10 @@ export type QueryRootUrlRedirectsArgs = {
|
|
|
7300
8161
|
query?: InputMaybe<Scalars['String']['input']>;
|
|
7301
8162
|
reverse?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7302
8163
|
};
|
|
7303
|
-
/**
|
|
8164
|
+
/**
|
|
8165
|
+
* Search engine optimization metadata for a resource. The title and description appear in search engine results and browser tabs.
|
|
8166
|
+
*
|
|
8167
|
+
*/
|
|
7304
8168
|
export type Seo = {
|
|
7305
8169
|
__typename?: 'SEO';
|
|
7306
8170
|
/** The meta description. */
|
|
@@ -7309,8 +8173,7 @@ export type Seo = {
|
|
|
7309
8173
|
title?: Maybe<Scalars['String']['output']>;
|
|
7310
8174
|
};
|
|
7311
8175
|
/**
|
|
7312
|
-
*
|
|
7313
|
-
* was created by a Shopify Script.
|
|
8176
|
+
* A discount application created by a Shopify Script. Implements the [`DiscountApplication`](https://shopify.dev/docs/api/storefront/current/interfaces/DiscountApplication) interface and captures the discount's value, allocation method, and targeting rules at the time the script applied it.
|
|
7314
8177
|
*
|
|
7315
8178
|
*/
|
|
7316
8179
|
export type ScriptDiscountApplication = DiscountApplication & {
|
|
@@ -7333,7 +8196,12 @@ export declare enum SearchPrefixQueryType {
|
|
|
7333
8196
|
/** Don't perform a partial word match on the last search term. */
|
|
7334
8197
|
None = "NONE"
|
|
7335
8198
|
}
|
|
7336
|
-
/**
|
|
8199
|
+
/**
|
|
8200
|
+
* A suggested search term returned by the [`predictiveSearch`](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) query. Query suggestions help customers refine their searches by showing relevant terms as they type.
|
|
8201
|
+
*
|
|
8202
|
+
* The [`text`](https://shopify.dev/docs/api/storefront/current/objects/SearchQuerySuggestion#field-SearchQuerySuggestion.fields.text) field provides the plain suggestion, while [`styledText`](https://shopify.dev/docs/api/storefront/current/objects/SearchQuerySuggestion#field-SearchQuerySuggestion.fields.styledText) includes HTML tags to highlight matching portions. Implements [`Trackable`](https://shopify.dev/docs/api/storefront/current/interfaces/Trackable) for analytics reporting on search traffic origins.
|
|
8203
|
+
*
|
|
8204
|
+
*/
|
|
7337
8205
|
export type SearchQuerySuggestion = Trackable & {
|
|
7338
8206
|
__typename?: 'SearchQuerySuggestion';
|
|
7339
8207
|
/** The text of the search query suggestion with highlighted HTML tags. */
|
|
@@ -7423,8 +8291,7 @@ export declare enum SearchableField {
|
|
|
7423
8291
|
Vendor = "VENDOR"
|
|
7424
8292
|
}
|
|
7425
8293
|
/**
|
|
7426
|
-
*
|
|
7427
|
-
* Products can have multiple options, like different sizes or colors.
|
|
8294
|
+
* A name/value pair representing a product option selection on a variant. The [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) object's [`selectedOptions`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant#field-ProductVariant.fields.selectedOptions) field returns this to indicate which options define that variant, such as "Size: Large" or "Color: Red".
|
|
7428
8295
|
*
|
|
7429
8296
|
*/
|
|
7430
8297
|
export type SelectedOption = {
|
|
@@ -7441,7 +8308,10 @@ export type SelectedOptionInput = {
|
|
|
7441
8308
|
/** The product option’s value. */
|
|
7442
8309
|
value: Scalars['String']['input'];
|
|
7443
8310
|
};
|
|
7444
|
-
/**
|
|
8311
|
+
/**
|
|
8312
|
+
* Represents deferred or recurring purchase options for [products](https://shopify.dev/docs/api/storefront/current/objects/Product) and [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), such as subscriptions, pre-orders, or try-before-you-buy. Each selling plan belongs to a [`SellingPlanGroup`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) and defines billing, pricing, inventory, and delivery policies.
|
|
8313
|
+
*
|
|
8314
|
+
*/
|
|
7445
8315
|
export type SellingPlan = HasMetafields & {
|
|
7446
8316
|
__typename?: 'SellingPlan';
|
|
7447
8317
|
/** The billing policy for the selling plan. */
|
|
@@ -7467,16 +8337,27 @@ export type SellingPlan = HasMetafields & {
|
|
|
7467
8337
|
/** Whether purchasing the selling plan will result in multiple deliveries. */
|
|
7468
8338
|
recurringDeliveries: Scalars['Boolean']['output'];
|
|
7469
8339
|
};
|
|
7470
|
-
/**
|
|
8340
|
+
/**
|
|
8341
|
+
* Represents deferred or recurring purchase options for [products](https://shopify.dev/docs/api/storefront/current/objects/Product) and [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), such as subscriptions, pre-orders, or try-before-you-buy. Each selling plan belongs to a [`SellingPlanGroup`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) and defines billing, pricing, inventory, and delivery policies.
|
|
8342
|
+
*
|
|
8343
|
+
*/
|
|
7471
8344
|
export type SellingPlanMetafieldArgs = {
|
|
7472
8345
|
key: Scalars['String']['input'];
|
|
7473
8346
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
7474
8347
|
};
|
|
7475
|
-
/**
|
|
8348
|
+
/**
|
|
8349
|
+
* Represents deferred or recurring purchase options for [products](https://shopify.dev/docs/api/storefront/current/objects/Product) and [product variants](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant), such as subscriptions, pre-orders, or try-before-you-buy. Each selling plan belongs to a [`SellingPlanGroup`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlanGroup) and defines billing, pricing, inventory, and delivery policies.
|
|
8350
|
+
*
|
|
8351
|
+
*/
|
|
7476
8352
|
export type SellingPlanMetafieldsArgs = {
|
|
7477
8353
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
7478
8354
|
};
|
|
7479
|
-
/**
|
|
8355
|
+
/**
|
|
8356
|
+
* Links a [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) to a [`SellingPlan`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlan), providing the pricing details for that specific combination. Each allocation includes the checkout charge amount, any remaining balance due for the purchase, and up to two price adjustments that show how the selling plan affects the variant's price.
|
|
8357
|
+
*
|
|
8358
|
+
* Selling plan allocations are available on product variants and [cart lines](https://shopify.dev/docs/api/storefront/current/objects/CartLine), enabling storefronts to display information such as subscription or purchase option pricing before and during checkout.
|
|
8359
|
+
*
|
|
8360
|
+
*/
|
|
7480
8361
|
export type SellingPlanAllocation = {
|
|
7481
8362
|
__typename?: 'SellingPlanAllocation';
|
|
7482
8363
|
/** The checkout charge amount due for the purchase. */
|
|
@@ -7587,7 +8468,12 @@ export type SellingPlanFixedPriceAdjustment = {
|
|
|
7587
8468
|
/** A new price of the variant when it's purchased with the selling plan. */
|
|
7588
8469
|
price: MoneyV2;
|
|
7589
8470
|
};
|
|
7590
|
-
/**
|
|
8471
|
+
/**
|
|
8472
|
+
* A selling method that defines how products can be sold through purchase options like subscriptions, pre-orders, or try-before-you-buy. Groups one or more [`SellingPlan`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlan) objects that share the same selling method and options.
|
|
8473
|
+
*
|
|
8474
|
+
* The `SellingPlanGroup` acts as a container for one or more individual `SellingPlan` objects, enabling merchants to offer multiple options (like weekly or monthly deliveries) under one, unified category on a product page.
|
|
8475
|
+
*
|
|
8476
|
+
*/
|
|
7591
8477
|
export type SellingPlanGroup = {
|
|
7592
8478
|
__typename?: 'SellingPlanGroup';
|
|
7593
8479
|
/** A display friendly name for the app that created the selling plan group. */
|
|
@@ -7599,7 +8485,12 @@ export type SellingPlanGroup = {
|
|
|
7599
8485
|
/** A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */
|
|
7600
8486
|
sellingPlans: SellingPlanConnection;
|
|
7601
8487
|
};
|
|
7602
|
-
/**
|
|
8488
|
+
/**
|
|
8489
|
+
* A selling method that defines how products can be sold through purchase options like subscriptions, pre-orders, or try-before-you-buy. Groups one or more [`SellingPlan`](https://shopify.dev/docs/api/storefront/current/objects/SellingPlan) objects that share the same selling method and options.
|
|
8490
|
+
*
|
|
8491
|
+
* The `SellingPlanGroup` acts as a container for one or more individual `SellingPlan` objects, enabling merchants to offer multiple options (like weekly or monthly deliveries) under one, unified category on a product page.
|
|
8492
|
+
*
|
|
8493
|
+
*/
|
|
7603
8494
|
export type SellingPlanGroupSellingPlansArgs = {
|
|
7604
8495
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
7605
8496
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -7694,11 +8585,18 @@ export type SellingPlanRecurringDeliveryPolicy = {
|
|
|
7694
8585
|
/** The number of intervals between deliveries. */
|
|
7695
8586
|
intervalCount: Scalars['Int']['output'];
|
|
7696
8587
|
};
|
|
7697
|
-
/**
|
|
8588
|
+
/**
|
|
8589
|
+
* The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the [`Brand`](https://shopify.dev/docs/api/storefront/current/objects/Brand) object.
|
|
8590
|
+
*
|
|
8591
|
+
* Access store policies such as privacy, refund, shipping, and terms of service via [`ShopPolicy`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicy), and the subscription policy via [`ShopPolicyWithDefault`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicyWithDefault). [`PaymentSettings`](https://shopify.dev/docs/api/storefront/current/objects/PaymentSettings) expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary [`Domain`](https://shopify.dev/docs/api/storefront/current/objects/Domain), countries the shop ships to, [`ShopPayInstallmentsPricing`](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing), and [`SocialLoginProvider`](https://shopify.dev/docs/api/storefront/current/objects/SocialLoginProvider) options for customer accounts.
|
|
8592
|
+
*
|
|
8593
|
+
*/
|
|
7698
8594
|
export type Shop = HasMetafields & Node & {
|
|
7699
8595
|
__typename?: 'Shop';
|
|
7700
8596
|
/** The shop's branding configuration. */
|
|
7701
8597
|
brand?: Maybe<Brand>;
|
|
8598
|
+
/** The shop's contact information. */
|
|
8599
|
+
contactInformation?: Maybe<ShopPolicy>;
|
|
7702
8600
|
/** Translations for customer accounts. */
|
|
7703
8601
|
customerAccountTranslations?: Maybe<Array<Translation>>;
|
|
7704
8602
|
/** The URL for the customer account (only present if shop has a customer account vanity domain). */
|
|
@@ -7707,6 +8605,8 @@ export type Shop = HasMetafields & Node & {
|
|
|
7707
8605
|
description?: Maybe<Scalars['String']['output']>;
|
|
7708
8606
|
/** A globally-unique ID. */
|
|
7709
8607
|
id: Scalars['ID']['output'];
|
|
8608
|
+
/** The shop's legal notice. */
|
|
8609
|
+
legalNotice?: Maybe<ShopPolicy>;
|
|
7710
8610
|
/** A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. */
|
|
7711
8611
|
metafield?: Maybe<Metafield>;
|
|
7712
8612
|
/** A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. */
|
|
@@ -7733,15 +8633,27 @@ export type Shop = HasMetafields & Node & {
|
|
|
7733
8633
|
socialLoginProviders: Array<SocialLoginProvider>;
|
|
7734
8634
|
/** The shop’s subscription policy. */
|
|
7735
8635
|
subscriptionPolicy?: Maybe<ShopPolicyWithDefault>;
|
|
8636
|
+
/** The shop's terms of sale. */
|
|
8637
|
+
termsOfSale?: Maybe<ShopPolicy>;
|
|
7736
8638
|
/** The shop’s terms of service. */
|
|
7737
8639
|
termsOfService?: Maybe<ShopPolicy>;
|
|
7738
8640
|
};
|
|
7739
|
-
/**
|
|
8641
|
+
/**
|
|
8642
|
+
* The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the [`Brand`](https://shopify.dev/docs/api/storefront/current/objects/Brand) object.
|
|
8643
|
+
*
|
|
8644
|
+
* Access store policies such as privacy, refund, shipping, and terms of service via [`ShopPolicy`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicy), and the subscription policy via [`ShopPolicyWithDefault`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicyWithDefault). [`PaymentSettings`](https://shopify.dev/docs/api/storefront/current/objects/PaymentSettings) expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary [`Domain`](https://shopify.dev/docs/api/storefront/current/objects/Domain), countries the shop ships to, [`ShopPayInstallmentsPricing`](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing), and [`SocialLoginProvider`](https://shopify.dev/docs/api/storefront/current/objects/SocialLoginProvider) options for customer accounts.
|
|
8645
|
+
*
|
|
8646
|
+
*/
|
|
7740
8647
|
export type ShopMetafieldArgs = {
|
|
7741
8648
|
key: Scalars['String']['input'];
|
|
7742
8649
|
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
7743
8650
|
};
|
|
7744
|
-
/**
|
|
8651
|
+
/**
|
|
8652
|
+
* The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the [`Brand`](https://shopify.dev/docs/api/storefront/current/objects/Brand) object.
|
|
8653
|
+
*
|
|
8654
|
+
* Access store policies such as privacy, refund, shipping, and terms of service via [`ShopPolicy`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicy), and the subscription policy via [`ShopPolicyWithDefault`](https://shopify.dev/docs/api/storefront/current/objects/ShopPolicyWithDefault). [`PaymentSettings`](https://shopify.dev/docs/api/storefront/current/objects/PaymentSettings) expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary [`Domain`](https://shopify.dev/docs/api/storefront/current/objects/Domain), countries the shop ships to, [`ShopPayInstallmentsPricing`](https://shopify.dev/docs/api/storefront/current/objects/ShopPayInstallmentsPricing), and [`SocialLoginProvider`](https://shopify.dev/docs/api/storefront/current/objects/SocialLoginProvider) options for customer accounts.
|
|
8655
|
+
*
|
|
8656
|
+
*/
|
|
7745
8657
|
export type ShopMetafieldsArgs = {
|
|
7746
8658
|
identifiers: Array<HasMetafieldsIdentifier>;
|
|
7747
8659
|
};
|
|
@@ -8264,8 +9176,11 @@ export type SocialLoginProvider = {
|
|
|
8264
9176
|
handle: Scalars['String']['output'];
|
|
8265
9177
|
};
|
|
8266
9178
|
/**
|
|
8267
|
-
*
|
|
8268
|
-
*
|
|
9179
|
+
* Inventory information for a product variant at a physical store location that offers local pickup. Includes stock availability, quantity on hand, and estimated pickup readiness time.
|
|
9180
|
+
*
|
|
9181
|
+
* Local pickup must be [enabled in the store's shipping settings](https://help.shopify.com/manual/shipping/setting-up-and-managing-your-shipping/local-methods/local-pickup) for this data to be returned. Results can be sorted by proximity to a customer's location using the `near` argument on the [`ProductVariant.storeAvailability`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant#field-ProductVariant.fields.storeAvailability) connection.
|
|
9182
|
+
*
|
|
9183
|
+
* Learn more about [supporting local pickup on storefronts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections/local-pickup).
|
|
8269
9184
|
*
|
|
8270
9185
|
*/
|
|
8271
9186
|
export type StoreAvailability = {
|
|
@@ -8468,7 +9383,10 @@ export type SubmitThrottled = {
|
|
|
8468
9383
|
*/
|
|
8469
9384
|
pollAfter: Scalars['DateTime']['output'];
|
|
8470
9385
|
};
|
|
8471
|
-
/**
|
|
9386
|
+
/**
|
|
9387
|
+
* A visual representation for filter values, containing a color, an image, or both. The [`FilterValue`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue) object's [`swatch`](https://shopify.dev/docs/api/storefront/current/objects/FilterValue#field-FilterValue.fields.swatch) field returns this when the filter's presentation is set to `SWATCH`.
|
|
9388
|
+
*
|
|
9389
|
+
*/
|
|
8472
9390
|
export type Swatch = {
|
|
8473
9391
|
__typename?: 'Swatch';
|
|
8474
9392
|
/** The swatch color. */
|
|
@@ -8519,7 +9437,9 @@ export type Translation = {
|
|
|
8519
9437
|
value: Scalars['String']['output'];
|
|
8520
9438
|
};
|
|
8521
9439
|
/**
|
|
8522
|
-
* The measurement used to calculate
|
|
9440
|
+
* The measurement data used to calculate unit prices for a [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant). Unit pricing helps customers compare costs across different package sizes by showing a standardized price, such as "$9.99 / 100ml".
|
|
9441
|
+
*
|
|
9442
|
+
* The object includes the quantity being sold (value and unit) and the reference measurement used for price comparison. Use this alongside the variant's [`unitPrice`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant#field-ProductVariant.fields.unitPrice) field to display complete unit pricing information.
|
|
8523
9443
|
*
|
|
8524
9444
|
*/
|
|
8525
9445
|
export type UnitPriceMeasurement = {
|
|
@@ -8720,7 +9640,10 @@ export type VisitorConsent = {
|
|
|
8720
9640
|
/** The visitor accepts or rejects the sale or sharing of their data with third parties. */
|
|
8721
9641
|
saleOfData?: InputMaybe<Scalars['Boolean']['input']>;
|
|
8722
9642
|
};
|
|
8723
|
-
/**
|
|
9643
|
+
/**
|
|
9644
|
+
* Units of measurement for weight, supporting both metric and imperial systems. Used by [`ProductVariant`](https://shopify.dev/docs/api/storefront/current/objects/ProductVariant) to specify the unit for the variant's weight value.
|
|
9645
|
+
*
|
|
9646
|
+
*/
|
|
8724
9647
|
export declare enum WeightUnit {
|
|
8725
9648
|
/** Metric system unit of mass. */
|
|
8726
9649
|
Grams = "GRAMS",
|