From 8398a962154a972d3af308ec48e01bebe5b92f7a Mon Sep 17 00:00:00 2001 From: Catalin Pinte Date: Wed, 28 Sep 2022 18:06:31 +0300 Subject: [PATCH] Update Shopify API version (#833) --- packages/shopify/codegen.json | 2 +- packages/shopify/schema.d.ts | 7068 ++++++++----- packages/shopify/schema.graphql | 9105 ++++++++++------- packages/shopify/src/const.ts | 2 +- packages/shopify/src/utils/normalize.ts | 4 +- .../utils/queries/get-all-products-query.ts | 2 +- .../src/utils/queries/get-checkout-query.ts | 2 +- .../src/utils/queries/get-product-query.ts | 2 +- 8 files changed, 10024 insertions(+), 6163 deletions(-) diff --git a/packages/shopify/codegen.json b/packages/shopify/codegen.json index c82882c77..157a2dcd6 100644 --- a/packages/shopify/codegen.json +++ b/packages/shopify/codegen.json @@ -1,6 +1,6 @@ { "schema": { - "https://${NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN}/api/2022-04/graphql.json": { + "https://${NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN}/api/2022-07/graphql.json": { "headers": { "X-Shopify-Storefront-Access-Token": "${NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN}" } diff --git a/packages/shopify/schema.d.ts b/packages/shopify/schema.d.ts index 328f0ff1b..6b5dce743 100644 --- a/packages/shopify/schema.d.ts +++ b/packages/shopify/schema.d.ts @@ -1,11 +1,14 @@ export type Maybe = T | null +export type InputMaybe = Maybe export type Exact = { [K in keyof T]: T[K] } -export type MakeOptional = Omit & - { [SubKey in K]?: Maybe } -export type MakeMaybe = Omit & - { [SubKey in K]: Maybe } +export type MakeOptional = Omit & { + [SubKey in K]?: Maybe +} +export type MakeMaybe = Omit & { + [SubKey in K]: Maybe +} /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { ID: string @@ -13,31 +16,26 @@ export type Scalars = { Boolean: boolean Int: number Float: number - /** An ISO-8601 encoded UTC date time string. Example value: `"2019-07-03T20:47:55Z"`. */ DateTime: any - /** A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `"29.99"`. */ Decimal: any - /** A string containing HTML code. Example value: `"

Grey cotton knit sweater.

"`. */ HTML: any - /** A monetary value string. Example value: `"100.57"`. */ + JSON: any Money: any - /** - * An RFC 3986 and RFC 3987 compliant URI string. - * - * Example value: `"https://johns-apparel.myshopify.com"`. - * - */ URL: any } -/** A version of the API. */ +/** + * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). + * Versions are commonly referred to by their handle (for example, `2021-10`). + * + */ export type ApiVersion = { __typename?: 'ApiVersion' /** The human-readable name of the version. */ displayName: Scalars['String'] /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ handle: Scalars['String'] - /** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/concepts/about-apis/versioning). */ + /** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning). */ supported: Scalars['Boolean'] } @@ -46,19 +44,19 @@ export type AppliedGiftCard = Node & { __typename?: 'AppliedGiftCard' /** * The amount that was taken from the gift card by applying it. - * @deprecated Use `amountUsedV2` instead + * @deprecated Use `amountUsedV2` instead. */ amountUsed: Scalars['Money'] /** The amount that was taken from the gift card by applying it. */ amountUsedV2: MoneyV2 /** * The amount left on the gift card. - * @deprecated Use `balanceV2` instead + * @deprecated Use `balanceV2` instead. */ balance: Scalars['Money'] /** The amount left on the gift card. */ balanceV2: MoneyV2 - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The last characters of the gift card. */ lastCharacters: Scalars['String'] @@ -67,70 +65,85 @@ export type AppliedGiftCard = Node & { } /** An article in an online store blog. */ -export type Article = Node & { - __typename?: 'Article' - /** - * The article's author. - * @deprecated Use `authorV2` instead - */ - author: ArticleAuthor - /** The article's author. */ - authorV2?: Maybe - /** The blog that the article belongs to. */ - blog: Blog - /** List of comments posted on the article. */ - comments: CommentConnection - /** Stripped content of the article, single line with HTML tags removed. */ - content: Scalars['String'] - /** The content of the article, complete with HTML formatting. */ - contentHtml: Scalars['HTML'] - /** Stripped excerpt of the article, single line with HTML tags removed. */ - excerpt?: Maybe - /** The excerpt of the article, complete with HTML formatting. */ - excerptHtml?: Maybe - /** A human-friendly unique string for the Article automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The image associated with the article. */ - image?: Maybe - /** The date and time when the article was published. */ - publishedAt: Scalars['DateTime'] - /** The article’s SEO information. */ - seo?: Maybe - /** A categorization that a article can be tagged with. */ - tags: Array - /** The article’s name. */ - title: Scalars['String'] - /** The url pointing to the article accessible from the web. */ - url: Scalars['URL'] -} +export type Article = HasMetafields & + Node & + OnlineStorePublishable & { + __typename?: 'Article' + /** + * The article's author. + * @deprecated Use `authorV2` instead. + */ + author: ArticleAuthor + /** The article's author. */ + authorV2?: Maybe + /** The blog that the article belongs to. */ + blog: Blog + /** List of comments posted on the article. */ + comments: CommentConnection + /** Stripped content of the article, single line with HTML tags removed. */ + content: Scalars['String'] + /** The content of the article, complete with HTML formatting. */ + contentHtml: Scalars['HTML'] + /** Stripped excerpt of the article, single line with HTML tags removed. */ + excerpt?: Maybe + /** The excerpt of the article, complete with HTML formatting. */ + excerptHtml?: Maybe + /** + * A human-friendly unique string for the Article automatically generated from its title. + * + */ + handle: Scalars['String'] + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The image associated with the article. */ + image?: Maybe + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe + /** The date and time when the article was published. */ + publishedAt: Scalars['DateTime'] + /** The article’s SEO information. */ + seo?: Maybe + /** A categorization that a article can be tagged with. */ + tags: Array + /** The article’s name. */ + title: Scalars['String'] + } /** An article in an online store blog. */ export type ArticleCommentsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** An article in an online store blog. */ export type ArticleContentArgs = { - truncateAt?: Maybe + truncateAt?: InputMaybe } /** An article in an online store blog. */ export type ArticleExcerptArgs = { - truncateAt?: Maybe + truncateAt?: InputMaybe } /** An article in an online store blog. */ -export type ArticleImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe +export type ArticleMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] +} + +/** An article in an online store blog. */ +export type ArticleMetafieldsArgs = { + identifiers: Array } /** The author of an article. */ @@ -148,16 +161,24 @@ export type ArticleAuthor = { name: Scalars['String'] } -/** An auto-generated type for paginating through multiple Articles. */ +/** + * An auto-generated type for paginating through multiple Articles. + * + */ export type ArticleConnection = { __typename?: 'ArticleConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in ArticleEdge. */ + nodes: Array
/** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Article and a cursor during pagination. */ +/** + * An auto-generated type which holds one Article and a cursor during pagination. + * + */ export type ArticleEdge = { __typename?: 'ArticleEdge' /** A cursor for use in pagination. */ @@ -168,24 +189,24 @@ export type ArticleEdge = { /** The set of valid sort keys for the Article query. */ export enum ArticleSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `blog_title` value. */ - BlogTitle = 'BLOG_TITLE', /** Sort by the `author` value. */ Author = 'AUTHOR', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `published_at` value. */ - PublishedAt = 'PUBLISHED_AT', + /** Sort by the `blog_title` value. */ + BlogTitle = 'BLOG_TITLE', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `published_at` value. */ + PublishedAt = 'PUBLISHED_AT', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `title` value. */ + Title = 'TITLE', + /** Sort by the `updated_at` value. */ + UpdatedAt = 'UPDATED_AT', } /** Represents a generic custom attribute. */ @@ -205,7 +226,10 @@ export type AttributeInput = { value: Scalars['String'] } -/** Automatic discount applications capture the intentions of a discount that was automatically applied. */ +/** + * Automatic discount applications capture the intentions of a discount that was automatically applied. + * + */ export type AutomaticDiscountApplication = DiscountApplication & { __typename?: 'AutomaticDiscountApplication' /** The method by which the discount's value is allocated to its entitled items. */ @@ -227,6 +251,7 @@ export type AvailableShippingRates = { * Whether or not the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. + * */ ready: Scalars['Boolean'] /** The fetched shipping rates. `null` until the `ready` field is `true`. */ @@ -234,25 +259,37 @@ export type AvailableShippingRates = { } /** An online store blog. */ -export type Blog = Node & { - __typename?: 'Blog' - /** Find an article by its handle. */ - articleByHandle?: Maybe
- /** List of the blog's articles. */ - articles: ArticleConnection - /** The authors who have contributed to the blog. */ - authors: Array - /** A human-friendly unique string for the Blog automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The blog's SEO information. */ - seo?: Maybe - /** The blogs’s title. */ - title: Scalars['String'] - /** The url pointing to the blog accessible from the web. */ - url: Scalars['URL'] -} +export type Blog = HasMetafields & + Node & + OnlineStorePublishable & { + __typename?: 'Blog' + /** Find an article by its handle. */ + articleByHandle?: Maybe
+ /** List of the blog's articles. */ + articles: ArticleConnection + /** The authors who have contributed to the blog. */ + authors: Array + /** + * A human-friendly unique string for the Blog automatically generated from its title. + * + */ + handle: Scalars['String'] + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe + /** The blog's SEO information. */ + seo?: Maybe + /** The blogs’s title. */ + title: Scalars['String'] + } /** An online store blog. */ export type BlogArticleByHandleArgs = { @@ -261,25 +298,44 @@ export type BlogArticleByHandleArgs = { /** An online store blog. */ export type BlogArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } -/** An auto-generated type for paginating through multiple Blogs. */ +/** An online store blog. */ +export type BlogMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] +} + +/** An online store blog. */ +export type BlogMetafieldsArgs = { + identifiers: Array +} + +/** + * An auto-generated type for paginating through multiple Blogs. + * + */ export type BlogConnection = { __typename?: 'BlogConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in BlogEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Blog and a cursor during pagination. */ +/** + * An auto-generated type which holds one Blog and a cursor during pagination. + * + */ export type BlogEdge = { __typename?: 'BlogEdge' /** A cursor for use in pagination. */ @@ -292,32 +348,503 @@ export type BlogEdge = { export enum BlogSortKeys { /** Sort by the `handle` value. */ Handle = 'HANDLE', - /** Sort by the `title` value. */ - Title = 'TITLE', /** Sort by the `id` value. */ Id = 'ID', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `title` value. */ + Title = 'TITLE', } /** Card brand, such as Visa or Mastercard, which can be used for payments. */ export enum CardBrand { - /** Visa. */ - Visa = 'VISA', - /** Mastercard. */ - Mastercard = 'MASTERCARD', - /** Discover. */ - Discover = 'DISCOVER', /** American Express. */ AmericanExpress = 'AMERICAN_EXPRESS', /** Diners Club. */ DinersClub = 'DINERS_CLUB', + /** Discover. */ + Discover = 'DISCOVER', /** JCB. */ Jcb = 'JCB', + /** Mastercard. */ + Mastercard = 'MASTERCARD', + /** Visa. */ + Visa = 'VISA', +} + +/** A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. To learn how to interact with a cart during a customer's session, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). */ +export type Cart = Node & { + __typename?: 'Cart' + /** An attribute associated with the cart. */ + attribute?: Maybe + /** The attributes associated with the cart. Attributes are represented as key-value pairs. */ + attributes: Array + /** Information about the buyer that is interacting with the cart. */ + buyerIdentity: CartBuyerIdentity + /** The URL of the checkout for the cart. */ + checkoutUrl: Scalars['URL'] + /** The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). */ + cost: CartCost + /** The date and time when the cart was created. */ + createdAt: Scalars['DateTime'] + /** The delivery groups available for the cart, based on the default address of the logged-in customer. */ + deliveryGroups: CartDeliveryGroupConnection + /** The discounts that have been applied to the entire cart. */ + discountAllocations: Array + /** + * The case-insensitive discount codes that the customer added at checkout. + * + */ + discountCodes: Array + /** + * The estimated costs that the buyer will pay at checkout. The estimated costs are subject to change and changes will be reflected at checkout. The `estimatedCost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). + * @deprecated Use `cost` instead. + */ + estimatedCost: CartEstimatedCost + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** A list of lines containing information about the items the customer intends to purchase. */ + lines: CartLineConnection + /** A note that is associated with the cart. For example, the note can be a personalized message to the buyer. */ + note?: Maybe + /** The total number of items in the cart. */ + totalQuantity: Scalars['Int'] + /** The date and time when the cart was updated. */ + updatedAt: Scalars['DateTime'] +} + +/** A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. To learn how to interact with a cart during a customer's session, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). */ +export type CartAttributeArgs = { + key: Scalars['String'] +} + +/** A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. To learn how to interact with a cart during a customer's session, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). */ +export type CartDeliveryGroupsArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. To learn how to interact with a cart during a customer's session, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). */ +export type CartLinesArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** Return type for `cartAttributesUpdate` mutation. */ +export type CartAttributesUpdatePayload = { + __typename?: 'CartAttributesUpdatePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** The discounts automatically applied to the cart line based on prerequisites that have been met. */ +export type CartAutomaticDiscountAllocation = CartDiscountAllocation & { + __typename?: 'CartAutomaticDiscountAllocation' + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2 + /** The title of the allocated discount. */ + title: Scalars['String'] +} + +/** Represents information about the buyer that is interacting with the cart. */ +export type CartBuyerIdentity = { + __typename?: 'CartBuyerIdentity' + /** The country where the buyer is located. */ + countryCode?: Maybe + /** The customer account associated with the cart. */ + customer?: Maybe + /** The email address of the buyer that is interacting with the cart. */ + email?: Maybe + /** The phone number of the buyer that is interacting with the cart. */ + phone?: Maybe +} + +/** + * Specifies the input fields to update the buyer information associated with a cart. + * Buyer identity is used to determine + * [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout) + * and should match the customer's shipping address. + * + */ +export type CartBuyerIdentityInput = { + /** The country where the buyer is located. */ + countryCode?: InputMaybe + /** The access token used to identify the customer associated with the cart. */ + customerAccessToken?: InputMaybe + /** The email address of the buyer that is interacting with the cart. */ + email?: InputMaybe + /** The phone number of the buyer that is interacting with the cart. */ + phone?: InputMaybe +} + +/** Return type for `cartBuyerIdentityUpdate` mutation. */ +export type CartBuyerIdentityUpdatePayload = { + __typename?: 'CartBuyerIdentityUpdatePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** The discount that has been applied to the cart line using a discount code. */ +export type CartCodeDiscountAllocation = CartDiscountAllocation & { + __typename?: 'CartCodeDiscountAllocation' + /** The code used to apply the discount. */ + code: Scalars['String'] + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2 +} + +/** + * The costs that the buyer will pay at checkout. + * It uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine + * [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). + * + */ +export type CartCost = { + __typename?: 'CartCost' + /** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to `subtotalAmount`. */ + checkoutChargeAmount: MoneyV2 + /** The amount, before taxes and cart-level discounts, for the customer to pay. */ + subtotalAmount: MoneyV2 + /** Whether the subtotal amount is estimated. */ + subtotalAmountEstimated: Scalars['Boolean'] + /** The total amount for the customer to pay. */ + totalAmount: MoneyV2 + /** Whether the total amount is estimated. */ + totalAmountEstimated: Scalars['Boolean'] + /** The duty amount for the customer to pay at checkout. */ + totalDutyAmount?: Maybe + /** Whether the total duty amount is estimated. */ + totalDutyAmountEstimated: Scalars['Boolean'] + /** The tax amount for the customer to pay at checkout. */ + totalTaxAmount?: Maybe + /** Whether the total tax amount is estimated. */ + totalTaxAmountEstimated: Scalars['Boolean'] +} + +/** Return type for `cartCreate` mutation. */ +export type CartCreatePayload = { + __typename?: 'CartCreatePayload' + /** The new cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** The discounts automatically applied to the cart line based on prerequisites that have been met. */ +export type CartCustomDiscountAllocation = CartDiscountAllocation & { + __typename?: 'CartCustomDiscountAllocation' + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2 + /** The title of the allocated discount. */ + title: Scalars['String'] +} + +/** Information about the options available for one or more line items to be delivered to a specific address. */ +export type CartDeliveryGroup = { + __typename?: 'CartDeliveryGroup' + /** A list of cart lines for the delivery group. */ + cartLines: CartLineConnection + /** The destination address for the delivery group. */ + deliveryAddress: MailingAddress + /** The delivery options available for the delivery group. */ + deliveryOptions: Array + /** The ID for the delivery group. */ + id: Scalars['ID'] +} + +/** Information about the options available for one or more line items to be delivered to a specific address. */ +export type CartDeliveryGroupCartLinesArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** + * An auto-generated type for paginating through multiple CartDeliveryGroups. + * + */ +export type CartDeliveryGroupConnection = { + __typename?: 'CartDeliveryGroupConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in CartDeliveryGroupEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination. + * + */ +export type CartDeliveryGroupEdge = { + __typename?: 'CartDeliveryGroupEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of CartDeliveryGroupEdge. */ + node: CartDeliveryGroup +} + +/** Information about a delivery option. */ +export type CartDeliveryOption = { + __typename?: 'CartDeliveryOption' + /** The code of the delivery option. */ + code?: Maybe + /** The method for the delivery option. */ + deliveryMethodType: DeliveryMethodType + /** The description of the delivery option. */ + description?: Maybe + /** The estimated cost for the delivery option. */ + estimatedCost: MoneyV2 + /** The title of the delivery option. */ + title?: Maybe +} + +/** The discounts that have been applied to the cart line. */ +export type CartDiscountAllocation = { + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2 +} + +/** The discount codes applied to the cart. */ +export type CartDiscountCode = { + __typename?: 'CartDiscountCode' + /** Whether the discount code is applicable to the cart's current contents. */ + applicable: Scalars['Boolean'] + /** The code for the discount. */ + code: Scalars['String'] +} + +/** Return type for `cartDiscountCodesUpdate` mutation. */ +export type CartDiscountCodesUpdatePayload = { + __typename?: 'CartDiscountCodesUpdatePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** Possible error codes that can be returned by `CartUserError`. */ +export enum CartErrorCode { + /** The input value is invalid. */ + Invalid = 'INVALID', + /** Merchandise line was not found in cart. */ + InvalidMerchandiseLine = 'INVALID_MERCHANDISE_LINE', + /** The input value should be less than the maximum value allowed. */ + LessThan = 'LESS_THAN', + /** Missing discount code. */ + MissingDiscountCode = 'MISSING_DISCOUNT_CODE', + /** Missing note. */ + MissingNote = 'MISSING_NOTE', +} + +/** + * The estimated costs that the buyer will pay at checkout. + * It uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine + * [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). + * + */ +export type CartEstimatedCost = { + __typename?: 'CartEstimatedCost' + /** 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`. */ + checkoutChargeAmount: MoneyV2 + /** The estimated amount, before taxes and discounts, for the customer to pay. */ + subtotalAmount: MoneyV2 + /** The estimated total amount for the customer to pay. */ + totalAmount: MoneyV2 + /** The estimated duty amount for the customer to pay at checkout. */ + totalDutyAmount?: Maybe + /** The estimated tax amount for the customer to pay at checkout. */ + totalTaxAmount?: Maybe +} + +/** Specifies the input fields to create a cart. */ +export type CartInput = { + /** An array of key-value pairs that contains additional information about the cart. */ + attributes?: InputMaybe> + /** The customer associated with the cart. Used to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout). Buyer identity should match the customer's shipping address. */ + buyerIdentity?: InputMaybe + /** + * The case-insensitive discount codes that the customer added at checkout. + * + */ + discountCodes?: InputMaybe> + /** A list of merchandise lines to add to the cart. */ + lines?: InputMaybe> + /** A note that is associated with the cart. For example, the note can be a personalized message to the buyer. */ + note?: InputMaybe +} + +/** Represents information about the merchandise in the cart. */ +export type CartLine = Node & { + __typename?: 'CartLine' + /** An attribute associated with the cart line. */ + attribute?: Maybe + /** The attributes associated with the cart line. Attributes are represented as key-value pairs. */ + attributes: Array + /** The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. */ + cost: CartLineCost + /** The discounts that have been applied to the cart line. */ + discountAllocations: Array + /** + * The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout. + * @deprecated Use `cost` instead. + */ + estimatedCost: CartLineEstimatedCost + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The merchandise that the buyer intends to purchase. */ + merchandise: Merchandise + /** The quantity of the merchandise that the customer intends to purchase. */ + quantity: Scalars['Int'] + /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ + sellingPlanAllocation?: Maybe +} + +/** Represents information about the merchandise in the cart. */ +export type CartLineAttributeArgs = { + key: Scalars['String'] +} + +/** + * An auto-generated type for paginating through multiple CartLines. + * + */ +export type CartLineConnection = { + __typename?: 'CartLineConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in CartLineEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** The cost of the merchandise line that the buyer will pay at checkout. */ +export type CartLineCost = { + __typename?: 'CartLineCost' + /** The amount of the merchandise line. */ + amountPerQuantity: MoneyV2 + /** The compare at amount of the merchandise line. */ + compareAtAmountPerQuantity?: Maybe + /** The cost of the merchandise line before line-level discounts. */ + subtotalAmount: MoneyV2 + /** The total cost of the merchandise line. */ + totalAmount: MoneyV2 +} + +/** + * An auto-generated type which holds one CartLine and a cursor during pagination. + * + */ +export type CartLineEdge = { + __typename?: 'CartLineEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of CartLineEdge. */ + node: CartLine +} + +/** The estimated cost of the merchandise line that the buyer will pay at checkout. */ +export type CartLineEstimatedCost = { + __typename?: 'CartLineEstimatedCost' + /** The amount of the merchandise line. */ + amount: MoneyV2 + /** The compare at amount of the merchandise line. */ + compareAtAmount?: Maybe + /** The estimated cost of the merchandise line before discounts. */ + subtotalAmount: MoneyV2 + /** The estimated total cost of the merchandise line. */ + totalAmount: MoneyV2 +} + +/** Specifies the input fields to create a merchandise line on a cart. */ +export type CartLineInput = { + /** An array of key-value pairs that contains additional information about the merchandise line. */ + attributes?: InputMaybe> + /** The identifier of the merchandise that the buyer intends to purchase. */ + merchandiseId: Scalars['ID'] + /** The quantity of the merchandise. */ + quantity?: InputMaybe + /** The identifier of the selling plan that the merchandise is being purchased with. */ + sellingPlanId?: InputMaybe +} + +/** Specifies the input fields to update a line item on a cart. */ +export type CartLineUpdateInput = { + /** An array of key-value pairs that contains additional information about the merchandise line. */ + attributes?: InputMaybe> + /** The identifier of the merchandise line. */ + id: Scalars['ID'] + /** The identifier of the merchandise for the line item. */ + merchandiseId?: InputMaybe + /** The quantity of the line item. */ + quantity?: InputMaybe + /** The identifier of the selling plan that the merchandise is being purchased with. */ + sellingPlanId?: InputMaybe +} + +/** Return type for `cartLinesAdd` mutation. */ +export type CartLinesAddPayload = { + __typename?: 'CartLinesAddPayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** Return type for `cartLinesRemove` mutation. */ +export type CartLinesRemovePayload = { + __typename?: 'CartLinesRemovePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** Return type for `cartLinesUpdate` mutation. */ +export type CartLinesUpdatePayload = { + __typename?: 'CartLinesUpdatePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** Return type for `cartNoteUpdate` mutation. */ +export type CartNoteUpdatePayload = { + __typename?: 'CartNoteUpdatePayload' + /** The updated cart. */ + cart?: Maybe + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array +} + +/** Represents an error that happens during execution of a cart mutation. */ +export type CartUserError = DisplayableError & { + __typename?: 'CartUserError' + /** The error code. */ + code?: Maybe + /** The path to the input field that caused the error. */ + field?: Maybe> + /** The error message. */ + message: Scalars['String'] } /** A container for all the information required to checkout items and pay. */ @@ -329,26 +856,24 @@ export type Checkout = Node & { * The available shipping rates for this Checkout. * Should only be used when checkout `requiresShipping` is `true` and * the shipping address is valid. + * */ availableShippingRates?: Maybe + /** The identity of the customer associated with the checkout. */ + buyerIdentity: CheckoutBuyerIdentity /** The date and time when the checkout was completed. */ completedAt?: Maybe /** The date and time when the checkout was created. */ createdAt: Scalars['DateTime'] - /** The currency code for the Checkout. */ + /** The currency code for the checkout. */ currencyCode: CurrencyCode /** A list of extra information that is added to the checkout. */ customAttributes: Array - /** - * The customer associated with the checkout. - * @deprecated This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it. - */ - customer?: Maybe /** Discounts that have been applied on the checkout. */ discountApplications: DiscountApplicationConnection /** The email attached to this checkout. */ email?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection @@ -362,47 +887,53 @@ export type Checkout = Node & { orderStatusUrl?: Maybe /** * The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards. - * @deprecated Use `paymentDueV2` instead + * @deprecated Use `paymentDueV2` instead. */ paymentDue: Scalars['Money'] - /** The amount left to be paid. This is equal to the cost of the line items, duties, taxes and shipping minus discounts and gift cards. */ + /** The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards. */ paymentDueV2: MoneyV2 /** * Whether or not the Checkout is ready and can be completed. Checkouts may * have asynchronous operations that can take time to finish. If you want * to complete a checkout or ensure all the fields are populated and up to * date, polling is required until the value is true. + * */ ready: Scalars['Boolean'] /** States whether or not the fulfillment requires shipping. */ requiresShipping: Scalars['Boolean'] /** The shipping address to where the line items will be shipped. */ shippingAddress?: Maybe - /** The discounts that have been allocated onto the shipping line by discount applications. */ + /** + * The discounts that have been allocated onto the shipping line by discount applications. + * + */ shippingDiscountAllocations: Array /** Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. */ shippingLine?: Maybe /** * Price of the checkout before shipping and taxes. - * @deprecated Use `subtotalPriceV2` instead + * @deprecated Use `subtotalPriceV2` instead. */ subtotalPrice: Scalars['Money'] - /** Price of the checkout before duties, shipping and taxes. */ + /** The price at checkout before duties, shipping, and taxes. */ subtotalPriceV2: MoneyV2 - /** Specifies if the Checkout is tax exempt. */ + /** Whether the checkout is tax exempt. */ taxExempt: Scalars['Boolean'] - /** Specifies if taxes are included in the line item and shipping line prices. */ + /** Whether taxes are included in the line item and shipping line prices. */ taxesIncluded: Scalars['Boolean'] + /** The sum of all the duties applied to the line items in the checkout. */ + totalDuties?: Maybe /** * The sum of all the prices of all the items in the checkout, taxes and discounts included. - * @deprecated Use `totalPriceV2` instead + * @deprecated Use `totalPriceV2` instead. */ totalPrice: Scalars['Money'] - /** The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. */ + /** The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts. */ totalPriceV2: MoneyV2 /** * The sum of all the taxes applied to the line items and shipping lines in the checkout. - * @deprecated Use `totalTaxV2` instead + * @deprecated Use `totalTaxV2` instead. */ totalTax: Scalars['Money'] /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */ @@ -415,62 +946,36 @@ export type Checkout = Node & { /** A container for all the information required to checkout items and pay. */ export type CheckoutDiscountApplicationsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** A container for all the information required to checkout items and pay. */ export type CheckoutLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** Specifies the fields required to update a checkout's attributes. */ -export type CheckoutAttributesUpdateInput = { - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> - /** - * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - * The required attributes are city, province, and country. - * Full validation of the addresses is still done at complete time. - */ - allowPartialAddresses?: Maybe -} - -/** Return type for `checkoutAttributesUpdate` mutation. */ -export type CheckoutAttributesUpdatePayload = { - __typename?: 'CheckoutAttributesUpdatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** Specifies the fields required to update a checkout's attributes. */ export type CheckoutAttributesUpdateV2Input = { - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> /** * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. * The required attributes are city, province, and country. - * Full validation of the addresses is still done at complete time. + * Full validation of the addresses is still done at completion time. Defaults to `false` with + * each operation. + * */ - allowPartialAddresses?: Maybe + allowPartialAddresses?: InputMaybe + /** A list of extra information that is added to the checkout. */ + customAttributes?: InputMaybe> + /** The text of an optional note that a shop owner can attach to the checkout. */ + note?: InputMaybe } /** Return type for `checkoutAttributesUpdateV2` mutation. */ @@ -478,41 +983,43 @@ export type CheckoutAttributesUpdateV2Payload = { __typename?: 'CheckoutAttributesUpdateV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } +/** The identity of the customer associated with the checkout. */ +export type CheckoutBuyerIdentity = { + __typename?: 'CheckoutBuyerIdentity' + /** The country code for the checkout. For example, `CA`. */ + countryCode?: Maybe +} + +/** Specifies the identity of the customer associated with the checkout. */ +export type CheckoutBuyerIdentityInput = { + /** + * The country code of one of the shop's + * [enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup). + * For example, `CA`. Including this field creates a checkout in the specified country's currency. + * + */ + countryCode: CountryCode +} + /** Return type for `checkoutCompleteFree` mutation. */ export type CheckoutCompleteFreePayload = { __typename?: 'CheckoutCompleteFreePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithCreditCard` mutation. */ -export type CheckoutCompleteWithCreditCardPayload = { - __typename?: 'CheckoutCompleteWithCreditCardPayload' - /** The checkout on which the payment was applied. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -522,45 +1029,13 @@ export type CheckoutCompleteWithCreditCardV2Payload = { __typename?: 'CheckoutCompleteWithCreditCardV2Payload' /** The checkout on which the payment was applied. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** A representation of the attempted payment. */ payment?: Maybe /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithTokenizedPayment` mutation. */ -export type CheckoutCompleteWithTokenizedPaymentPayload = { - __typename?: 'CheckoutCompleteWithTokenizedPaymentPayload' - /** The checkout on which the payment was applied. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithTokenizedPaymentV2` mutation. */ -export type CheckoutCompleteWithTokenizedPaymentV2Payload = { - __typename?: 'CheckoutCompleteWithTokenizedPaymentV2Payload' - /** The checkout on which the payment was applied. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -570,41 +1045,38 @@ export type CheckoutCompleteWithTokenizedPaymentV3Payload = { __typename?: 'CheckoutCompleteWithTokenizedPaymentV3Payload' /** The checkout on which the payment was applied. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** A representation of the attempted payment. */ payment?: Maybe /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } /** Specifies the fields required to create a checkout. */ export type CheckoutCreateInput = { - /** The email with which the customer wants to checkout. */ - email?: Maybe - /** A list of line item objects, each one containing information about an item in the checkout. */ - lineItems?: Maybe> - /** The shipping address to where the line items will be shipped. */ - shippingAddress?: Maybe - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> /** * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. * The required attributes are city, province, and country. - * Full validation of addresses is still done at complete time. + * Full validation of addresses is still done at completion time. Defaults to `null`. + * */ - allowPartialAddresses?: Maybe - /** - * The three-letter currency code of one of the shop's enabled presentment currencies. - * Including this field creates a checkout in the specified currency. By default, new - * checkouts are created in the shop's primary currency. - */ - presentmentCurrencyCode?: Maybe + allowPartialAddresses?: InputMaybe + /** The identity of the customer associated with the checkout. */ + buyerIdentity?: InputMaybe + /** A list of extra information that is added to the checkout. */ + customAttributes?: InputMaybe> + /** The email with which the customer wants to checkout. */ + email?: InputMaybe + /** A list of line item objects, each one containing information about an item in the checkout. */ + lineItems?: InputMaybe> + /** The text of an optional note that a shop owner can attach to the checkout. */ + note?: InputMaybe + /** The shipping address to where the line items will be shipped. */ + shippingAddress?: InputMaybe } /** Return type for `checkoutCreate` mutation. */ @@ -612,52 +1084,29 @@ export type CheckoutCreatePayload = { __typename?: 'CheckoutCreatePayload' /** The new checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array + /** The checkout queue token. Available only to selected stores. */ + queueToken?: Maybe /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } -/** Return type for `checkoutCustomerAssociate` mutation. */ -export type CheckoutCustomerAssociatePayload = { - __typename?: 'CheckoutCustomerAssociatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** The associated customer object. */ - customer?: Maybe - /** List of errors that occurred executing the mutation. */ - userErrors: Array -} - /** Return type for `checkoutCustomerAssociateV2` mutation. */ export type CheckoutCustomerAssociateV2Payload = { __typename?: 'CheckoutCustomerAssociateV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** The associated customer object. */ customer?: Maybe /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCustomerDisassociate` mutation. */ -export type CheckoutCustomerDisassociatePayload = { - __typename?: 'CheckoutCustomerDisassociatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -667,25 +1116,11 @@ export type CheckoutCustomerDisassociateV2Payload = { __typename?: 'CheckoutCustomerDisassociateV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutDiscountCodeApply` mutation. */ -export type CheckoutDiscountCodeApplyPayload = { - __typename?: 'CheckoutDiscountCodeApplyPayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -695,11 +1130,11 @@ export type CheckoutDiscountCodeApplyV2Payload = { __typename?: 'CheckoutDiscountCodeApplyV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -709,25 +1144,11 @@ export type CheckoutDiscountCodeRemovePayload = { __typename?: 'CheckoutDiscountCodeRemovePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutEmailUpdate` mutation. */ -export type CheckoutEmailUpdatePayload = { - __typename?: 'CheckoutEmailUpdatePayload' - /** The checkout object with the updated email. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -737,121 +1158,105 @@ export type CheckoutEmailUpdateV2Payload = { __typename?: 'CheckoutEmailUpdateV2Payload' /** The checkout object with the updated email. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } -/** Possible error codes that could be returned by CheckoutUserError. */ +/** Possible error codes that can be returned by `CheckoutUserError`. */ export enum CheckoutErrorCode { - /** Input value is blank. */ - Blank = 'BLANK', - /** Input value is invalid. */ - Invalid = 'INVALID', - /** Input value is too long. */ - TooLong = 'TOO_LONG', - /** Input value is not present. */ - Present = 'PRESENT', - /** Input value should be less than maximum allowed value. */ - LessThan = 'LESS_THAN', - /** Input value should be greater than or equal to minimum allowed value. */ - GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', - /** Input value should be less or equal to maximum allowed value. */ - LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Checkout is already completed. */ AlreadyCompleted = 'ALREADY_COMPLETED', - /** Checkout is locked. */ - Locked = 'LOCKED', - /** Input value is not supported. */ - NotSupported = 'NOT_SUPPORTED', /** Input email contains an invalid domain name. */ BadDomain = 'BAD_DOMAIN', - /** Input Zip is invalid for country provided. */ - InvalidForCountry = 'INVALID_FOR_COUNTRY', - /** Input Zip is invalid for country and province provided. */ - InvalidForCountryAndProvince = 'INVALID_FOR_COUNTRY_AND_PROVINCE', - /** Invalid state in country. */ - InvalidStateInCountry = 'INVALID_STATE_IN_COUNTRY', - /** Invalid province in country. */ - InvalidProvinceInCountry = 'INVALID_PROVINCE_IN_COUNTRY', - /** Invalid region in country. */ - InvalidRegionInCountry = 'INVALID_REGION_IN_COUNTRY', - /** Shipping rate expired. */ - ShippingRateExpired = 'SHIPPING_RATE_EXPIRED', - /** Gift card cannot be applied to a checkout that contains a gift card. */ - GiftCardUnusable = 'GIFT_CARD_UNUSABLE', - /** Gift card is disabled. */ - GiftCardDisabled = 'GIFT_CARD_DISABLED', - /** Gift card code is invalid. */ - GiftCardCodeInvalid = 'GIFT_CARD_CODE_INVALID', - /** Gift card has already been applied. */ - GiftCardAlreadyApplied = 'GIFT_CARD_ALREADY_APPLIED', - /** Gift card currency does not match checkout currency. */ - GiftCardCurrencyMismatch = 'GIFT_CARD_CURRENCY_MISMATCH', - /** Gift card is expired. */ - GiftCardExpired = 'GIFT_CARD_EXPIRED', - /** Gift card has no funds left. */ - GiftCardDepleted = 'GIFT_CARD_DEPLETED', - /** Gift card was not found. */ - GiftCardNotFound = 'GIFT_CARD_NOT_FOUND', + /** The input value is blank. */ + Blank = 'BLANK', /** Cart does not meet discount requirements notice. */ CartDoesNotMeetDiscountRequirementsNotice = 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE', - /** Discount expired. */ - DiscountExpired = 'DISCOUNT_EXPIRED', + /** Customer already used once per customer discount notice. */ + CustomerAlreadyUsedOncePerCustomerDiscountNotice = 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE', + /** Discount already applied. */ + DiscountAlreadyApplied = 'DISCOUNT_ALREADY_APPLIED', /** Discount disabled. */ DiscountDisabled = 'DISCOUNT_DISABLED', + /** Discount expired. */ + DiscountExpired = 'DISCOUNT_EXPIRED', /** Discount limit reached. */ DiscountLimitReached = 'DISCOUNT_LIMIT_REACHED', /** Discount not found. */ DiscountNotFound = 'DISCOUNT_NOT_FOUND', - /** Customer already used once per customer discount notice. */ - CustomerAlreadyUsedOncePerCustomerDiscountNotice = 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE', /** Checkout is already completed. */ Empty = 'EMPTY', - /** Not enough in stock. */ - NotEnoughInStock = 'NOT_ENOUGH_IN_STOCK', - /** Missing payment input. */ - MissingPaymentInput = 'MISSING_PAYMENT_INPUT', - /** The amount of the payment does not match the value to be paid. */ - TotalPriceMismatch = 'TOTAL_PRICE_MISMATCH', + /** Queue token has expired. */ + ExpiredQueueToken = 'EXPIRED_QUEUE_TOKEN', + /** Gift card has already been applied. */ + GiftCardAlreadyApplied = 'GIFT_CARD_ALREADY_APPLIED', + /** Gift card code is invalid. */ + GiftCardCodeInvalid = 'GIFT_CARD_CODE_INVALID', + /** Gift card currency does not match checkout currency. */ + GiftCardCurrencyMismatch = 'GIFT_CARD_CURRENCY_MISMATCH', + /** Gift card has no funds left. */ + GiftCardDepleted = 'GIFT_CARD_DEPLETED', + /** Gift card is disabled. */ + GiftCardDisabled = 'GIFT_CARD_DISABLED', + /** Gift card is expired. */ + GiftCardExpired = 'GIFT_CARD_EXPIRED', + /** Gift card was not found. */ + GiftCardNotFound = 'GIFT_CARD_NOT_FOUND', + /** Gift card cannot be applied to a checkout that contains a gift card. */ + GiftCardUnusable = 'GIFT_CARD_UNUSABLE', + /** The input value should be greater than or equal to the minimum value allowed. */ + GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', + /** Higher value discount applied. */ + HigherValueDiscountApplied = 'HIGHER_VALUE_DISCOUNT_APPLIED', + /** The input value is invalid. */ + Invalid = 'INVALID', + /** Cannot specify country and presentment currency code. */ + InvalidCountryAndCurrency = 'INVALID_COUNTRY_AND_CURRENCY', + /** Input Zip is invalid for country provided. */ + InvalidForCountry = 'INVALID_FOR_COUNTRY', + /** Input Zip is invalid for country and province provided. */ + InvalidForCountryAndProvince = 'INVALID_FOR_COUNTRY_AND_PROVINCE', + /** Invalid province in country. */ + InvalidProvinceInCountry = 'INVALID_PROVINCE_IN_COUNTRY', + /** Queue token is invalid. */ + InvalidQueueToken = 'INVALID_QUEUE_TOKEN', + /** Invalid region in country. */ + InvalidRegionInCountry = 'INVALID_REGION_IN_COUNTRY', + /** Invalid state in country. */ + InvalidStateInCountry = 'INVALID_STATE_IN_COUNTRY', + /** The input value should be less than the maximum value allowed. */ + LessThan = 'LESS_THAN', + /** The input value should be less than or equal to the maximum value allowed. */ + LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Line item was not found in checkout. */ LineItemNotFound = 'LINE_ITEM_NOT_FOUND', + /** Checkout is locked. */ + Locked = 'LOCKED', + /** Maximum number of discount codes limit reached. */ + MaximumDiscountCodeLimitReached = 'MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED', + /** Missing payment input. */ + MissingPaymentInput = 'MISSING_PAYMENT_INPUT', + /** Not enough in stock. */ + NotEnoughInStock = 'NOT_ENOUGH_IN_STOCK', + /** Input value is not supported. */ + NotSupported = 'NOT_SUPPORTED', + /** The input value needs to be blank. */ + Present = 'PRESENT', + /** Shipping rate expired. */ + ShippingRateExpired = 'SHIPPING_RATE_EXPIRED', + /** Throttled during checkout. */ + ThrottledDuringCheckout = 'THROTTLED_DURING_CHECKOUT', + /** The input value is too long. */ + TooLong = 'TOO_LONG', + /** The amount of the payment does not match the value to be paid. */ + TotalPriceMismatch = 'TOTAL_PRICE_MISMATCH', /** Unable to apply discount. */ UnableToApply = 'UNABLE_TO_APPLY', - /** Discount already applied. */ - DiscountAlreadyApplied = 'DISCOUNT_ALREADY_APPLIED', -} - -/** Return type for `checkoutGiftCardApply` mutation. */ -export type CheckoutGiftCardApplyPayload = { - __typename?: 'CheckoutGiftCardApplyPayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutGiftCardRemove` mutation. */ -export type CheckoutGiftCardRemovePayload = { - __typename?: 'CheckoutGiftCardRemovePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array } /** Return type for `checkoutGiftCardRemoveV2` mutation. */ @@ -859,11 +1264,11 @@ export type CheckoutGiftCardRemoveV2Payload = { __typename?: 'CheckoutGiftCardRemoveV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -873,11 +1278,11 @@ export type CheckoutGiftCardsAppendPayload = { __typename?: 'CheckoutGiftCardsAppendPayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -889,7 +1294,7 @@ export type CheckoutLineItem = Node & { customAttributes: Array /** The discounts that have been allocated onto the checkout line item by discount applications. */ discountAllocations: Array - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The quantity of the line item. */ quantity: Scalars['Int'] @@ -901,16 +1306,24 @@ export type CheckoutLineItem = Node & { variant?: Maybe } -/** An auto-generated type for paginating through multiple CheckoutLineItems. */ +/** + * An auto-generated type for paginating through multiple CheckoutLineItems. + * + */ export type CheckoutLineItemConnection = { __typename?: 'CheckoutLineItemConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in CheckoutLineItemEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. */ +/** + * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. + * + */ export type CheckoutLineItemEdge = { __typename?: 'CheckoutLineItemEdge' /** A cursor for use in pagination. */ @@ -922,7 +1335,7 @@ export type CheckoutLineItemEdge = { /** Specifies the input fields to create a line item on a checkout. */ export type CheckoutLineItemInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ - customAttributes?: Maybe> + customAttributes?: InputMaybe> /** The quantity of the line item. */ quantity: Scalars['Int'] /** The identifier of the product variant for the line item. */ @@ -931,14 +1344,14 @@ export type CheckoutLineItemInput = { /** Specifies the input fields to update a line item on the checkout. */ export type CheckoutLineItemUpdateInput = { - /** The identifier of the line item. */ - id?: Maybe - /** The variant identifier of the line item. */ - variantId?: Maybe - /** The quantity of the line item. */ - quantity?: Maybe /** Extra information in the form of an array of Key-Value pairs about the line item. */ - customAttributes?: Maybe> + customAttributes?: InputMaybe> + /** The identifier of the line item. */ + id?: InputMaybe + /** The quantity of the line item. */ + quantity?: InputMaybe + /** The variant identifier of the line item. */ + variantId?: InputMaybe } /** Return type for `checkoutLineItemsAdd` mutation. */ @@ -946,11 +1359,11 @@ export type CheckoutLineItemsAddPayload = { __typename?: 'CheckoutLineItemsAddPayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -960,11 +1373,11 @@ export type CheckoutLineItemsRemovePayload = { __typename?: 'CheckoutLineItemsRemovePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -974,7 +1387,7 @@ export type CheckoutLineItemsReplacePayload = { __typename?: 'CheckoutLineItemsReplacePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ userErrors: Array } @@ -983,25 +1396,11 @@ export type CheckoutLineItemsUpdatePayload = { __typename?: 'CheckoutLineItemsUpdatePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutShippingAddressUpdate` mutation. */ -export type CheckoutShippingAddressUpdatePayload = { - __typename?: 'CheckoutShippingAddressUpdatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -1011,11 +1410,11 @@ export type CheckoutShippingAddressUpdateV2Payload = { __typename?: 'CheckoutShippingAddressUpdateV2Payload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -1025,11 +1424,11 @@ export type CheckoutShippingLineUpdatePayload = { __typename?: 'CheckoutShippingLineUpdatePayload' /** The updated checkout object. */ checkout?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array } @@ -1037,71 +1436,97 @@ export type CheckoutShippingLineUpdatePayload = { /** Represents an error that happens during execution of a checkout mutation. */ export type CheckoutUserError = DisplayableError & { __typename?: 'CheckoutUserError' - /** Error code to uniquely identify the error. */ + /** The error code. */ code?: Maybe - /** Path to the input field which caused the error. */ + /** The path to the input field that caused the error. */ field?: Maybe> /** The error message. */ message: Scalars['String'] } /** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type Collection = Node & { - __typename?: 'Collection' - /** Stripped description of the collection, single line with HTML tags removed. */ - description: Scalars['String'] - /** The description of the collection, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML'] - /** - * A human-friendly unique string for the collection automatically generated from its title. - * Limit of 255 characters. - */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** Image associated with the collection. */ - image?: Maybe - /** List of products in the collection. */ - products: ProductConnection - /** The collection’s name. Limit of 255 characters. */ - title: Scalars['String'] - /** The date and time when the collection was last modified. */ - updatedAt: Scalars['DateTime'] -} +export type Collection = HasMetafields & + Node & + OnlineStorePublishable & { + __typename?: 'Collection' + /** Stripped description of the collection, single line with HTML tags removed. */ + description: Scalars['String'] + /** The description of the collection, complete with HTML formatting. */ + descriptionHtml: Scalars['HTML'] + /** + * A human-friendly unique string for the collection automatically generated from its title. + * Limit of 255 characters. + * + */ + handle: Scalars['String'] + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** Image associated with the collection. */ + image?: Maybe + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe + /** List of products in the collection. */ + products: ProductConnection + /** The collection's SEO information. */ + seo: Seo + /** The collection’s name. Limit of 255 characters. */ + title: Scalars['String'] + /** The date and time when the collection was last modified. */ + updatedAt: Scalars['DateTime'] + } /** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ export type CollectionDescriptionArgs = { - truncateAt?: Maybe + truncateAt?: InputMaybe } /** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type CollectionImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe +export type CollectionMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] +} + +/** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ +export type CollectionMetafieldsArgs = { + identifiers: Array } /** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ export type CollectionProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe + after?: InputMaybe + before?: InputMaybe + filters?: InputMaybe> + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } -/** An auto-generated type for paginating through multiple Collections. */ +/** + * An auto-generated type for paginating through multiple Collections. + * + */ export type CollectionConnection = { __typename?: 'CollectionConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in CollectionEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Collection and a cursor during pagination. */ +/** + * An auto-generated type which holds one Collection and a cursor during pagination. + * + */ export type CollectionEdge = { __typename?: 'CollectionEdge' /** A cursor for use in pagination. */ @@ -1112,18 +1537,18 @@ export type CollectionEdge = { /** The set of valid sort keys for the Collection query. */ export enum CollectionSortKeys { + /** Sort by the `id` value. */ + Id = 'ID', + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + Relevance = 'RELEVANCE', /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', } /** A comment on an article. */ @@ -1135,13 +1560,13 @@ export type Comment = Node & { content: Scalars['String'] /** The content of the comment, complete with HTML formatting. */ contentHtml: Scalars['HTML'] - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] } /** A comment on an article. */ export type CommentContentArgs = { - truncateAt?: Maybe + truncateAt?: InputMaybe } /** The author of a comment. */ @@ -1153,16 +1578,24 @@ export type CommentAuthor = { name: Scalars['String'] } -/** An auto-generated type for paginating through multiple Comments. */ +/** + * An auto-generated type for paginating through multiple Comments. + * + */ export type CommentConnection = { __typename?: 'CommentConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in CommentEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Comment and a cursor during pagination. */ +/** + * An auto-generated type which holds one Comment and a cursor during pagination. + * + */ export type CommentEdge = { __typename?: 'CommentEdge' /** A cursor for use in pagination. */ @@ -1171,496 +1604,519 @@ export type CommentEdge = { node: Comment } -/** ISO 3166-1 alpha-2 country codes with some differences. */ +/** A country. */ +export type Country = { + __typename?: 'Country' + /** The languages available for the country. */ + availableLanguages: Array + /** The currency of the country. */ + currency: Currency + /** The ISO code of the country. */ + isoCode: CountryCode + /** The name of the country. */ + name: Scalars['String'] + /** The unit system used in the country. */ + unitSystem: UnitSystem +} + +/** + * The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines. + * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision + * of another country. For example, the territories associated with Spain are represented by the country code `ES`, + * and the territories associated with the United States of America are represented by the country code `US`. + * + */ export enum CountryCode { - /** Afghanistan. */ - Af = 'AF', - /** Åland Islands. */ - Ax = 'AX', - /** Albania. */ - Al = 'AL', - /** Algeria. */ - Dz = 'DZ', - /** Andorra. */ - Ad = 'AD', - /** Angola. */ - Ao = 'AO', - /** Anguilla. */ - Ai = 'AI', - /** Antigua & Barbuda. */ - Ag = 'AG', - /** Argentina. */ - Ar = 'AR', - /** Armenia. */ - Am = 'AM', - /** Aruba. */ - Aw = 'AW', /** Ascension Island. */ Ac = 'AC', - /** Australia. */ - Au = 'AU', + /** Andorra. */ + Ad = 'AD', + /** United Arab Emirates. */ + Ae = 'AE', + /** Afghanistan. */ + Af = 'AF', + /** Antigua & Barbuda. */ + Ag = 'AG', + /** Anguilla. */ + Ai = 'AI', + /** Albania. */ + Al = 'AL', + /** Armenia. */ + Am = 'AM', + /** Netherlands Antilles. */ + An = 'AN', + /** Angola. */ + Ao = 'AO', + /** Argentina. */ + Ar = 'AR', /** Austria. */ At = 'AT', + /** Australia. */ + Au = 'AU', + /** Aruba. */ + Aw = 'AW', + /** Åland Islands. */ + Ax = 'AX', /** Azerbaijan. */ Az = 'AZ', - /** Bahamas. */ - Bs = 'BS', - /** Bahrain. */ - Bh = 'BH', - /** Bangladesh. */ - Bd = 'BD', - /** Barbados. */ - Bb = 'BB', - /** Belarus. */ - By = 'BY', - /** Belgium. */ - Be = 'BE', - /** Belize. */ - Bz = 'BZ', - /** Benin. */ - Bj = 'BJ', - /** Bermuda. */ - Bm = 'BM', - /** Bhutan. */ - Bt = 'BT', - /** Bolivia. */ - Bo = 'BO', /** Bosnia & Herzegovina. */ Ba = 'BA', - /** Botswana. */ - Bw = 'BW', - /** Bouvet Island. */ - Bv = 'BV', - /** Brazil. */ - Br = 'BR', - /** British Indian Ocean Territory. */ - Io = 'IO', - /** Brunei. */ - Bn = 'BN', - /** Bulgaria. */ - Bg = 'BG', + /** Barbados. */ + Bb = 'BB', + /** Bangladesh. */ + Bd = 'BD', + /** Belgium. */ + Be = 'BE', /** Burkina Faso. */ Bf = 'BF', + /** Bulgaria. */ + Bg = 'BG', + /** Bahrain. */ + Bh = 'BH', /** Burundi. */ Bi = 'BI', - /** Cambodia. */ - Kh = 'KH', - /** Canada. */ - Ca = 'CA', - /** Cape Verde. */ - Cv = 'CV', + /** Benin. */ + Bj = 'BJ', + /** St. Barthélemy. */ + Bl = 'BL', + /** Bermuda. */ + Bm = 'BM', + /** Brunei. */ + Bn = 'BN', + /** Bolivia. */ + Bo = 'BO', /** Caribbean Netherlands. */ Bq = 'BQ', - /** Cayman Islands. */ - Ky = 'KY', - /** Central African Republic. */ - Cf = 'CF', - /** Chad. */ - Td = 'TD', - /** Chile. */ - Cl = 'CL', - /** China. */ - Cn = 'CN', - /** Christmas Island. */ - Cx = 'CX', + /** Brazil. */ + Br = 'BR', + /** Bahamas. */ + Bs = 'BS', + /** Bhutan. */ + Bt = 'BT', + /** Bouvet Island. */ + Bv = 'BV', + /** Botswana. */ + Bw = 'BW', + /** Belarus. */ + By = 'BY', + /** Belize. */ + Bz = 'BZ', + /** Canada. */ + Ca = 'CA', /** Cocos (Keeling) Islands. */ Cc = 'CC', - /** Colombia. */ - Co = 'CO', - /** Comoros. */ - Km = 'KM', - /** Congo - Brazzaville. */ - Cg = 'CG', /** Congo - Kinshasa. */ Cd = 'CD', + /** Central African Republic. */ + Cf = 'CF', + /** Congo - Brazzaville. */ + Cg = 'CG', + /** Switzerland. */ + Ch = 'CH', + /** Côte d’Ivoire. */ + Ci = 'CI', /** Cook Islands. */ Ck = 'CK', + /** Chile. */ + Cl = 'CL', + /** Cameroon. */ + Cm = 'CM', + /** China. */ + Cn = 'CN', + /** Colombia. */ + Co = 'CO', /** Costa Rica. */ Cr = 'CR', - /** Croatia. */ - Hr = 'HR', /** Cuba. */ Cu = 'CU', + /** Cape Verde. */ + Cv = 'CV', /** Curaçao. */ Cw = 'CW', + /** Christmas Island. */ + Cx = 'CX', /** Cyprus. */ Cy = 'CY', /** Czechia. */ Cz = 'CZ', - /** Côte d’Ivoire. */ - Ci = 'CI', - /** Denmark. */ - Dk = 'DK', + /** Germany. */ + De = 'DE', /** Djibouti. */ Dj = 'DJ', + /** Denmark. */ + Dk = 'DK', /** Dominica. */ Dm = 'DM', /** Dominican Republic. */ Do = 'DO', + /** Algeria. */ + Dz = 'DZ', /** Ecuador. */ Ec = 'EC', - /** Egypt. */ - Eg = 'EG', - /** El Salvador. */ - Sv = 'SV', - /** Equatorial Guinea. */ - Gq = 'GQ', - /** Eritrea. */ - Er = 'ER', /** Estonia. */ Ee = 'EE', - /** Eswatini. */ - Sz = 'SZ', + /** Egypt. */ + Eg = 'EG', + /** Western Sahara. */ + Eh = 'EH', + /** Eritrea. */ + Er = 'ER', + /** Spain. */ + Es = 'ES', /** Ethiopia. */ Et = 'ET', + /** Finland. */ + Fi = 'FI', + /** Fiji. */ + Fj = 'FJ', /** Falkland Islands. */ Fk = 'FK', /** Faroe Islands. */ Fo = 'FO', - /** Fiji. */ - Fj = 'FJ', - /** Finland. */ - Fi = 'FI', /** France. */ Fr = 'FR', - /** French Guiana. */ - Gf = 'GF', - /** French Polynesia. */ - Pf = 'PF', - /** French Southern Territories. */ - Tf = 'TF', /** Gabon. */ Ga = 'GA', - /** Gambia. */ - Gm = 'GM', + /** United Kingdom. */ + Gb = 'GB', + /** Grenada. */ + Gd = 'GD', /** Georgia. */ Ge = 'GE', - /** Germany. */ - De = 'DE', + /** French Guiana. */ + Gf = 'GF', + /** Guernsey. */ + Gg = 'GG', /** Ghana. */ Gh = 'GH', /** Gibraltar. */ Gi = 'GI', - /** Greece. */ - Gr = 'GR', /** Greenland. */ Gl = 'GL', - /** Grenada. */ - Gd = 'GD', - /** Guadeloupe. */ - Gp = 'GP', - /** Guatemala. */ - Gt = 'GT', - /** Guernsey. */ - Gg = 'GG', + /** Gambia. */ + Gm = 'GM', /** Guinea. */ Gn = 'GN', + /** Guadeloupe. */ + Gp = 'GP', + /** Equatorial Guinea. */ + Gq = 'GQ', + /** Greece. */ + Gr = 'GR', + /** South Georgia & South Sandwich Islands. */ + Gs = 'GS', + /** Guatemala. */ + Gt = 'GT', /** Guinea-Bissau. */ Gw = 'GW', /** Guyana. */ Gy = 'GY', - /** Haiti. */ - Ht = 'HT', - /** Heard & McDonald Islands. */ - Hm = 'HM', - /** Vatican City. */ - Va = 'VA', - /** Honduras. */ - Hn = 'HN', /** Hong Kong SAR. */ Hk = 'HK', + /** Heard & McDonald Islands. */ + Hm = 'HM', + /** Honduras. */ + Hn = 'HN', + /** Croatia. */ + Hr = 'HR', + /** Haiti. */ + Ht = 'HT', /** Hungary. */ Hu = 'HU', - /** Iceland. */ - Is = 'IS', - /** India. */ - In = 'IN', /** Indonesia. */ Id = 'ID', - /** Iran. */ - Ir = 'IR', - /** Iraq. */ - Iq = 'IQ', /** Ireland. */ Ie = 'IE', - /** Isle of Man. */ - Im = 'IM', /** Israel. */ Il = 'IL', + /** Isle of Man. */ + Im = 'IM', + /** India. */ + In = 'IN', + /** British Indian Ocean Territory. */ + Io = 'IO', + /** Iraq. */ + Iq = 'IQ', + /** Iran. */ + Ir = 'IR', + /** Iceland. */ + Is = 'IS', /** Italy. */ It = 'IT', - /** Jamaica. */ - Jm = 'JM', - /** Japan. */ - Jp = 'JP', /** Jersey. */ Je = 'JE', + /** Jamaica. */ + Jm = 'JM', /** Jordan. */ Jo = 'JO', - /** Kazakhstan. */ - Kz = 'KZ', + /** Japan. */ + Jp = 'JP', /** Kenya. */ Ke = 'KE', - /** Kiribati. */ - Ki = 'KI', - /** North Korea. */ - Kp = 'KP', - /** Kosovo. */ - Xk = 'XK', - /** Kuwait. */ - Kw = 'KW', /** Kyrgyzstan. */ Kg = 'KG', + /** Cambodia. */ + Kh = 'KH', + /** Kiribati. */ + Ki = 'KI', + /** Comoros. */ + Km = 'KM', + /** St. Kitts & Nevis. */ + Kn = 'KN', + /** North Korea. */ + Kp = 'KP', + /** South Korea. */ + Kr = 'KR', + /** Kuwait. */ + Kw = 'KW', + /** Cayman Islands. */ + Ky = 'KY', + /** Kazakhstan. */ + Kz = 'KZ', /** Laos. */ La = 'LA', - /** Latvia. */ - Lv = 'LV', /** Lebanon. */ Lb = 'LB', - /** Lesotho. */ - Ls = 'LS', - /** Liberia. */ - Lr = 'LR', - /** Libya. */ - Ly = 'LY', + /** St. Lucia. */ + Lc = 'LC', /** Liechtenstein. */ Li = 'LI', + /** Sri Lanka. */ + Lk = 'LK', + /** Liberia. */ + Lr = 'LR', + /** Lesotho. */ + Ls = 'LS', /** Lithuania. */ Lt = 'LT', /** Luxembourg. */ Lu = 'LU', - /** Macao SAR. */ - Mo = 'MO', + /** Latvia. */ + Lv = 'LV', + /** Libya. */ + Ly = 'LY', + /** Morocco. */ + Ma = 'MA', + /** Monaco. */ + Mc = 'MC', + /** Moldova. */ + Md = 'MD', + /** Montenegro. */ + Me = 'ME', + /** St. Martin. */ + Mf = 'MF', /** Madagascar. */ Mg = 'MG', - /** Malawi. */ - Mw = 'MW', - /** Malaysia. */ - My = 'MY', - /** Maldives. */ - Mv = 'MV', + /** North Macedonia. */ + Mk = 'MK', /** Mali. */ Ml = 'ML', - /** Malta. */ - Mt = 'MT', + /** Myanmar (Burma). */ + Mm = 'MM', + /** Mongolia. */ + Mn = 'MN', + /** Macao SAR. */ + Mo = 'MO', /** Martinique. */ Mq = 'MQ', /** Mauritania. */ Mr = 'MR', - /** Mauritius. */ - Mu = 'MU', - /** Mayotte. */ - Yt = 'YT', - /** Mexico. */ - Mx = 'MX', - /** Moldova. */ - Md = 'MD', - /** Monaco. */ - Mc = 'MC', - /** Mongolia. */ - Mn = 'MN', - /** Montenegro. */ - Me = 'ME', /** Montserrat. */ Ms = 'MS', - /** Morocco. */ - Ma = 'MA', + /** Malta. */ + Mt = 'MT', + /** Mauritius. */ + Mu = 'MU', + /** Maldives. */ + Mv = 'MV', + /** Malawi. */ + Mw = 'MW', + /** Mexico. */ + Mx = 'MX', + /** Malaysia. */ + My = 'MY', /** Mozambique. */ Mz = 'MZ', - /** Myanmar (Burma). */ - Mm = 'MM', /** Namibia. */ Na = 'NA', - /** Nauru. */ - Nr = 'NR', - /** Nepal. */ - Np = 'NP', - /** Netherlands. */ - Nl = 'NL', - /** Netherlands Antilles. */ - An = 'AN', /** New Caledonia. */ Nc = 'NC', - /** New Zealand. */ - Nz = 'NZ', - /** Nicaragua. */ - Ni = 'NI', /** Niger. */ Ne = 'NE', - /** Nigeria. */ - Ng = 'NG', - /** Niue. */ - Nu = 'NU', /** Norfolk Island. */ Nf = 'NF', - /** North Macedonia. */ - Mk = 'MK', + /** Nigeria. */ + Ng = 'NG', + /** Nicaragua. */ + Ni = 'NI', + /** Netherlands. */ + Nl = 'NL', /** Norway. */ No = 'NO', + /** Nepal. */ + Np = 'NP', + /** Nauru. */ + Nr = 'NR', + /** Niue. */ + Nu = 'NU', + /** New Zealand. */ + Nz = 'NZ', /** Oman. */ Om = 'OM', - /** Pakistan. */ - Pk = 'PK', - /** Palestinian Territories. */ - Ps = 'PS', /** Panama. */ Pa = 'PA', - /** Papua New Guinea. */ - Pg = 'PG', - /** Paraguay. */ - Py = 'PY', /** Peru. */ Pe = 'PE', + /** French Polynesia. */ + Pf = 'PF', + /** Papua New Guinea. */ + Pg = 'PG', /** Philippines. */ Ph = 'PH', - /** Pitcairn Islands. */ - Pn = 'PN', + /** Pakistan. */ + Pk = 'PK', /** Poland. */ Pl = 'PL', + /** St. Pierre & Miquelon. */ + Pm = 'PM', + /** Pitcairn Islands. */ + Pn = 'PN', + /** Palestinian Territories. */ + Ps = 'PS', /** Portugal. */ Pt = 'PT', + /** Paraguay. */ + Py = 'PY', /** Qatar. */ Qa = 'QA', - /** Cameroon. */ - Cm = 'CM', /** Réunion. */ Re = 'RE', /** Romania. */ Ro = 'RO', + /** Serbia. */ + Rs = 'RS', /** Russia. */ Ru = 'RU', /** Rwanda. */ Rw = 'RW', - /** St. Barthélemy. */ - Bl = 'BL', - /** St. Helena. */ - Sh = 'SH', - /** St. Kitts & Nevis. */ - Kn = 'KN', - /** St. Lucia. */ - Lc = 'LC', - /** St. Martin. */ - Mf = 'MF', - /** St. Pierre & Miquelon. */ - Pm = 'PM', - /** Samoa. */ - Ws = 'WS', - /** San Marino. */ - Sm = 'SM', - /** São Tomé & Príncipe. */ - St = 'ST', /** Saudi Arabia. */ Sa = 'SA', - /** Senegal. */ - Sn = 'SN', - /** Serbia. */ - Rs = 'RS', - /** Seychelles. */ - Sc = 'SC', - /** Sierra Leone. */ - Sl = 'SL', - /** Singapore. */ - Sg = 'SG', - /** Sint Maarten. */ - Sx = 'SX', - /** Slovakia. */ - Sk = 'SK', - /** Slovenia. */ - Si = 'SI', /** Solomon Islands. */ Sb = 'SB', - /** Somalia. */ - So = 'SO', - /** South Africa. */ - Za = 'ZA', - /** South Georgia & South Sandwich Islands. */ - Gs = 'GS', - /** South Korea. */ - Kr = 'KR', - /** South Sudan. */ - Ss = 'SS', - /** Spain. */ - Es = 'ES', - /** Sri Lanka. */ - Lk = 'LK', - /** St. Vincent & Grenadines. */ - Vc = 'VC', + /** Seychelles. */ + Sc = 'SC', /** Sudan. */ Sd = 'SD', - /** Suriname. */ - Sr = 'SR', - /** Svalbard & Jan Mayen. */ - Sj = 'SJ', /** Sweden. */ Se = 'SE', - /** Switzerland. */ - Ch = 'CH', + /** Singapore. */ + Sg = 'SG', + /** St. Helena. */ + Sh = 'SH', + /** Slovenia. */ + Si = 'SI', + /** Svalbard & Jan Mayen. */ + Sj = 'SJ', + /** Slovakia. */ + Sk = 'SK', + /** Sierra Leone. */ + Sl = 'SL', + /** San Marino. */ + Sm = 'SM', + /** Senegal. */ + Sn = 'SN', + /** Somalia. */ + So = 'SO', + /** Suriname. */ + Sr = 'SR', + /** South Sudan. */ + Ss = 'SS', + /** São Tomé & Príncipe. */ + St = 'ST', + /** El Salvador. */ + Sv = 'SV', + /** Sint Maarten. */ + Sx = 'SX', /** Syria. */ Sy = 'SY', - /** Taiwan. */ - Tw = 'TW', - /** Tajikistan. */ - Tj = 'TJ', - /** Tanzania. */ - Tz = 'TZ', - /** Thailand. */ - Th = 'TH', - /** Timor-Leste. */ - Tl = 'TL', - /** Togo. */ - Tg = 'TG', - /** Tokelau. */ - Tk = 'TK', - /** Tonga. */ - To = 'TO', - /** Trinidad & Tobago. */ - Tt = 'TT', + /** Eswatini. */ + Sz = 'SZ', /** Tristan da Cunha. */ Ta = 'TA', - /** Tunisia. */ - Tn = 'TN', - /** Turkey. */ - Tr = 'TR', - /** Turkmenistan. */ - Tm = 'TM', /** Turks & Caicos Islands. */ Tc = 'TC', + /** Chad. */ + Td = 'TD', + /** French Southern Territories. */ + Tf = 'TF', + /** Togo. */ + Tg = 'TG', + /** Thailand. */ + Th = 'TH', + /** Tajikistan. */ + Tj = 'TJ', + /** Tokelau. */ + Tk = 'TK', + /** Timor-Leste. */ + Tl = 'TL', + /** Turkmenistan. */ + Tm = 'TM', + /** Tunisia. */ + Tn = 'TN', + /** Tonga. */ + To = 'TO', + /** Turkey. */ + Tr = 'TR', + /** Trinidad & Tobago. */ + Tt = 'TT', /** Tuvalu. */ Tv = 'TV', - /** Uganda. */ - Ug = 'UG', + /** Taiwan. */ + Tw = 'TW', + /** Tanzania. */ + Tz = 'TZ', /** Ukraine. */ Ua = 'UA', - /** United Arab Emirates. */ - Ae = 'AE', - /** United Kingdom. */ - Gb = 'GB', - /** United States. */ - Us = 'US', + /** Uganda. */ + Ug = 'UG', /** U.S. Outlying Islands. */ Um = 'UM', + /** United States. */ + Us = 'US', /** Uruguay. */ Uy = 'UY', /** Uzbekistan. */ Uz = 'UZ', - /** Vanuatu. */ - Vu = 'VU', + /** Vatican City. */ + Va = 'VA', + /** St. Vincent & Grenadines. */ + Vc = 'VC', /** Venezuela. */ Ve = 'VE', - /** Vietnam. */ - Vn = 'VN', /** British Virgin Islands. */ Vg = 'VG', + /** Vietnam. */ + Vn = 'VN', + /** Vanuatu. */ + Vu = 'VU', /** Wallis & Futuna. */ Wf = 'WF', - /** Western Sahara. */ - Eh = 'EH', + /** Samoa. */ + Ws = 'WS', + /** Kosovo. */ + Xk = 'XK', /** Yemen. */ Ye = 'YE', + /** Mayotte. */ + Yt = 'YT', + /** South Africa. */ + Za = 'ZA', /** Zambia. */ Zm = 'ZM', /** Zimbabwe. */ Zw = 'ZW', + /** Unknown Region. */ + Zz = 'ZZ', } /** Credit card information used for a payment. */ @@ -1687,373 +2143,387 @@ export type CreditCard = { /** * Specifies the fields required to complete a checkout with * a Shopify vaulted credit card payment. - */ -export type CreditCardPaymentInput = { - /** The amount of the payment. */ - amount: Scalars['Money'] - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe -} - -/** - * Specifies the fields required to complete a checkout with - * a Shopify vaulted credit card payment. + * */ export type CreditCardPaymentInputV2 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ - idempotencyKey: Scalars['String'] /** The billing address for the payment. */ billingAddress: MailingAddressInput + /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ + idempotencyKey: Scalars['String'] + /** The amount and currency of the payment. */ + paymentAmount: MoneyInput + /** Executes the payment in test mode if possible. Defaults to `false`. */ + test?: InputMaybe /** The ID returned by Shopify's Card Vault. */ vaultId: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe } /** The part of the image that should remain after cropping. */ export enum CropRegion { - /** Keep the center of the image. */ - Center = 'CENTER', - /** Keep the top of the image. */ - Top = 'TOP', /** Keep the bottom of the image. */ Bottom = 'BOTTOM', + /** Keep the center of the image. */ + Center = 'CENTER', /** Keep the left of the image. */ Left = 'LEFT', /** Keep the right of the image. */ Right = 'RIGHT', + /** Keep the top of the image. */ + Top = 'TOP', } -/** Currency codes. */ +/** A currency. */ +export type Currency = { + __typename?: 'Currency' + /** The ISO code of the currency. */ + isoCode: CurrencyCode + /** The name of the currency. */ + name: Scalars['String'] + /** The symbol of the currency. */ + symbol: Scalars['String'] +} + +/** + * The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes, + * and non-standard codes. + * + */ export enum CurrencyCode { - /** United States Dollars (USD). */ - Usd = 'USD', - /** Euro (EUR). */ - Eur = 'EUR', - /** United Kingdom Pounds (GBP). */ - Gbp = 'GBP', - /** Canadian Dollars (CAD). */ - Cad = 'CAD', + /** United Arab Emirates Dirham (AED). */ + Aed = 'AED', /** Afghan Afghani (AFN). */ Afn = 'AFN', /** Albanian Lek (ALL). */ All = 'ALL', - /** Algerian Dinar (DZD). */ - Dzd = 'DZD', + /** Armenian Dram (AMD). */ + Amd = 'AMD', + /** Netherlands Antillean Guilder. */ + Ang = 'ANG', /** Angolan Kwanza (AOA). */ Aoa = 'AOA', /** Argentine Pesos (ARS). */ Ars = 'ARS', - /** Armenian Dram (AMD). */ - Amd = 'AMD', - /** Aruban Florin (AWG). */ - Awg = 'AWG', /** Australian Dollars (AUD). */ Aud = 'AUD', - /** Barbadian Dollar (BBD). */ - Bbd = 'BBD', + /** Aruban Florin (AWG). */ + Awg = 'AWG', /** Azerbaijani Manat (AZN). */ Azn = 'AZN', + /** Bosnia and Herzegovina Convertible Mark (BAM). */ + Bam = 'BAM', + /** Barbadian Dollar (BBD). */ + Bbd = 'BBD', /** Bangladesh Taka (BDT). */ Bdt = 'BDT', - /** Bahamian Dollar (BSD). */ - Bsd = 'BSD', + /** Bulgarian Lev (BGN). */ + Bgn = 'BGN', /** Bahraini Dinar (BHD). */ Bhd = 'BHD', /** Burundian Franc (BIF). */ Bif = 'BIF', - /** Belize Dollar (BZD). */ - Bzd = 'BZD', /** Bermudian Dollar (BMD). */ Bmd = 'BMD', - /** Bhutanese Ngultrum (BTN). */ - Btn = 'BTN', - /** Bosnia and Herzegovina Convertible Mark (BAM). */ - Bam = 'BAM', - /** Brazilian Real (BRL). */ - Brl = 'BRL', - /** Bolivian Boliviano (BOB). */ - Bob = 'BOB', - /** Botswana Pula (BWP). */ - Bwp = 'BWP', /** Brunei Dollar (BND). */ Bnd = 'BND', - /** Bulgarian Lev (BGN). */ - Bgn = 'BGN', - /** Burmese Kyat (MMK). */ - Mmk = 'MMK', - /** Cambodian Riel. */ - Khr = 'KHR', - /** Cape Verdean escudo (CVE). */ - Cve = 'CVE', - /** Cayman Dollars (KYD). */ - Kyd = 'KYD', - /** Central African CFA Franc (XAF). */ - Xaf = 'XAF', + /** Bolivian Boliviano (BOB). */ + Bob = 'BOB', + /** Brazilian Real (BRL). */ + Brl = 'BRL', + /** Bahamian Dollar (BSD). */ + Bsd = 'BSD', + /** Bhutanese Ngultrum (BTN). */ + Btn = 'BTN', + /** Botswana Pula (BWP). */ + Bwp = 'BWP', + /** Belarusian Ruble (BYN). */ + Byn = 'BYN', + /** + * Belarusian Ruble (BYR). + * @deprecated `BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead. + */ + Byr = 'BYR', + /** Belize Dollar (BZD). */ + Bzd = 'BZD', + /** Canadian Dollars (CAD). */ + Cad = 'CAD', + /** Congolese franc (CDF). */ + Cdf = 'CDF', + /** Swiss Francs (CHF). */ + Chf = 'CHF', /** Chilean Peso (CLP). */ Clp = 'CLP', /** Chinese Yuan Renminbi (CNY). */ Cny = 'CNY', /** Colombian Peso (COP). */ Cop = 'COP', - /** Comorian Franc (KMF). */ - Kmf = 'KMF', - /** Congolese franc (CDF). */ - Cdf = 'CDF', /** Costa Rican Colones (CRC). */ Crc = 'CRC', - /** Croatian Kuna (HRK). */ - Hrk = 'HRK', + /** Cape Verdean escudo (CVE). */ + Cve = 'CVE', /** Czech Koruny (CZK). */ Czk = 'CZK', + /** Djiboutian Franc (DJF). */ + Djf = 'DJF', /** Danish Kroner (DKK). */ Dkk = 'DKK', /** Dominican Peso (DOP). */ Dop = 'DOP', - /** East Caribbean Dollar (XCD). */ - Xcd = 'XCD', + /** Algerian Dinar (DZD). */ + Dzd = 'DZD', /** Egyptian Pound (EGP). */ Egp = 'EGP', + /** Eritrean Nakfa (ERN). */ + Ern = 'ERN', /** Ethiopian Birr (ETB). */ Etb = 'ETB', - /** CFP Franc (XPF). */ - Xpf = 'XPF', + /** Euro (EUR). */ + Eur = 'EUR', /** Fijian Dollars (FJD). */ Fjd = 'FJD', - /** Gambian Dalasi (GMD). */ - Gmd = 'GMD', + /** Falkland Islands Pounds (FKP). */ + Fkp = 'FKP', + /** United Kingdom Pounds (GBP). */ + Gbp = 'GBP', + /** Georgian Lari (GEL). */ + Gel = 'GEL', /** Ghanaian Cedi (GHS). */ Ghs = 'GHS', + /** Gibraltar Pounds (GIP). */ + Gip = 'GIP', + /** Gambian Dalasi (GMD). */ + Gmd = 'GMD', + /** Guinean Franc (GNF). */ + Gnf = 'GNF', /** Guatemalan Quetzal (GTQ). */ Gtq = 'GTQ', /** Guyanese Dollar (GYD). */ Gyd = 'GYD', - /** Georgian Lari (GEL). */ - Gel = 'GEL', - /** Haitian Gourde (HTG). */ - Htg = 'HTG', - /** Honduran Lempira (HNL). */ - Hnl = 'HNL', /** Hong Kong Dollars (HKD). */ Hkd = 'HKD', + /** Honduran Lempira (HNL). */ + Hnl = 'HNL', + /** Croatian Kuna (HRK). */ + Hrk = 'HRK', + /** Haitian Gourde (HTG). */ + Htg = 'HTG', /** Hungarian Forint (HUF). */ Huf = 'HUF', - /** Icelandic Kronur (ISK). */ - Isk = 'ISK', - /** Indian Rupees (INR). */ - Inr = 'INR', /** Indonesian Rupiah (IDR). */ Idr = 'IDR', /** Israeli New Shekel (NIS). */ Ils = 'ILS', + /** Indian Rupees (INR). */ + Inr = 'INR', /** Iraqi Dinar (IQD). */ Iqd = 'IQD', - /** Jamaican Dollars (JMD). */ - Jmd = 'JMD', - /** Japanese Yen (JPY). */ - Jpy = 'JPY', + /** Iranian Rial (IRR). */ + Irr = 'IRR', + /** Icelandic Kronur (ISK). */ + Isk = 'ISK', /** Jersey Pound. */ Jep = 'JEP', + /** Jamaican Dollars (JMD). */ + Jmd = 'JMD', /** Jordanian Dinar (JOD). */ Jod = 'JOD', - /** Kazakhstani Tenge (KZT). */ - Kzt = 'KZT', + /** Japanese Yen (JPY). */ + Jpy = 'JPY', /** Kenyan Shilling (KES). */ Kes = 'KES', - /** Kuwaiti Dinar (KWD). */ - Kwd = 'KWD', /** Kyrgyzstani Som (KGS). */ Kgs = 'KGS', + /** Cambodian Riel. */ + Khr = 'KHR', + /** Kiribati Dollar (KID). */ + Kid = 'KID', + /** Comorian Franc (KMF). */ + Kmf = 'KMF', + /** South Korean Won (KRW). */ + Krw = 'KRW', + /** Kuwaiti Dinar (KWD). */ + Kwd = 'KWD', + /** Cayman Dollars (KYD). */ + Kyd = 'KYD', + /** Kazakhstani Tenge (KZT). */ + Kzt = 'KZT', /** Laotian Kip (LAK). */ Lak = 'LAK', - /** Latvian Lati (LVL). */ - Lvl = 'LVL', /** Lebanese Pounds (LBP). */ Lbp = 'LBP', - /** Lesotho Loti (LSL). */ - Lsl = 'LSL', + /** Sri Lankan Rupees (LKR). */ + Lkr = 'LKR', /** Liberian Dollar (LRD). */ Lrd = 'LRD', + /** Lesotho Loti (LSL). */ + Lsl = 'LSL', /** Lithuanian Litai (LTL). */ Ltl = 'LTL', + /** Latvian Lati (LVL). */ + Lvl = 'LVL', + /** Libyan Dinar (LYD). */ + Lyd = 'LYD', + /** Moroccan Dirham. */ + Mad = 'MAD', + /** Moldovan Leu (MDL). */ + Mdl = 'MDL', /** Malagasy Ariary (MGA). */ Mga = 'MGA', /** Macedonia Denar (MKD). */ Mkd = 'MKD', + /** Burmese Kyat (MMK). */ + Mmk = 'MMK', + /** Mongolian Tugrik. */ + Mnt = 'MNT', /** Macanese Pataca (MOP). */ Mop = 'MOP', - /** Malawian Kwacha (MWK). */ - Mwk = 'MWK', + /** Mauritanian Ouguiya (MRU). */ + Mru = 'MRU', + /** Mauritian Rupee (MUR). */ + Mur = 'MUR', /** Maldivian Rufiyaa (MVR). */ Mvr = 'MVR', + /** Malawian Kwacha (MWK). */ + Mwk = 'MWK', /** Mexican Pesos (MXN). */ Mxn = 'MXN', /** Malaysian Ringgits (MYR). */ Myr = 'MYR', - /** Mauritian Rupee (MUR). */ - Mur = 'MUR', - /** Moldovan Leu (MDL). */ - Mdl = 'MDL', - /** Moroccan Dirham. */ - Mad = 'MAD', - /** Mongolian Tugrik. */ - Mnt = 'MNT', /** Mozambican Metical. */ Mzn = 'MZN', /** Namibian Dollar. */ Nad = 'NAD', - /** Nepalese Rupee (NPR). */ - Npr = 'NPR', - /** Netherlands Antillean Guilder. */ - Ang = 'ANG', - /** New Zealand Dollars (NZD). */ - Nzd = 'NZD', - /** Nicaraguan Córdoba (NIO). */ - Nio = 'NIO', /** Nigerian Naira (NGN). */ Ngn = 'NGN', + /** Nicaraguan Córdoba (NIO). */ + Nio = 'NIO', /** Norwegian Kroner (NOK). */ Nok = 'NOK', + /** Nepalese Rupee (NPR). */ + Npr = 'NPR', + /** New Zealand Dollars (NZD). */ + Nzd = 'NZD', /** Omani Rial (OMR). */ Omr = 'OMR', /** Panamian Balboa (PAB). */ Pab = 'PAB', - /** Pakistani Rupee (PKR). */ - Pkr = 'PKR', - /** Papua New Guinean Kina (PGK). */ - Pgk = 'PGK', - /** Paraguayan Guarani (PYG). */ - Pyg = 'PYG', /** Peruvian Nuevo Sol (PEN). */ Pen = 'PEN', + /** Papua New Guinean Kina (PGK). */ + Pgk = 'PGK', /** Philippine Peso (PHP). */ Php = 'PHP', + /** Pakistani Rupee (PKR). */ + Pkr = 'PKR', /** Polish Zlotych (PLN). */ Pln = 'PLN', + /** Paraguayan Guarani (PYG). */ + Pyg = 'PYG', /** Qatari Rial (QAR). */ Qar = 'QAR', /** Romanian Lei (RON). */ Ron = 'RON', + /** Serbian dinar (RSD). */ + Rsd = 'RSD', /** Russian Rubles (RUB). */ Rub = 'RUB', /** Rwandan Franc (RWF). */ Rwf = 'RWF', - /** Samoan Tala (WST). */ - Wst = 'WST', /** Saudi Riyal (SAR). */ Sar = 'SAR', - /** Sao Tome And Principe Dobra (STD). */ - Std = 'STD', - /** Serbian dinar (RSD). */ - Rsd = 'RSD', - /** Seychellois Rupee (SCR). */ - Scr = 'SCR', - /** Singapore Dollars (SGD). */ - Sgd = 'SGD', - /** Sudanese Pound (SDG). */ - Sdg = 'SDG', - /** Syrian Pound (SYP). */ - Syp = 'SYP', - /** South African Rand (ZAR). */ - Zar = 'ZAR', - /** South Korean Won (KRW). */ - Krw = 'KRW', - /** South Sudanese Pound (SSP). */ - Ssp = 'SSP', /** Solomon Islands Dollar (SBD). */ Sbd = 'SBD', - /** Sri Lankan Rupees (LKR). */ - Lkr = 'LKR', - /** Surinamese Dollar (SRD). */ - Srd = 'SRD', - /** Swazi Lilangeni (SZL). */ - Szl = 'SZL', + /** Seychellois Rupee (SCR). */ + Scr = 'SCR', + /** Sudanese Pound (SDG). */ + Sdg = 'SDG', /** Swedish Kronor (SEK). */ Sek = 'SEK', - /** Swiss Francs (CHF). */ - Chf = 'CHF', - /** Taiwan Dollars (TWD). */ - Twd = 'TWD', + /** Singapore Dollars (SGD). */ + Sgd = 'SGD', + /** Saint Helena Pounds (SHP). */ + Shp = 'SHP', + /** Sierra Leonean Leone (SLL). */ + Sll = 'SLL', + /** Somali Shilling (SOS). */ + Sos = 'SOS', + /** Surinamese Dollar (SRD). */ + Srd = 'SRD', + /** South Sudanese Pound (SSP). */ + Ssp = 'SSP', + /** + * Sao Tome And Principe Dobra (STD). + * @deprecated `STD` is deprecated. Use `STN` available from version `2022-07` onwards instead. + */ + Std = 'STD', + /** Sao Tome And Principe Dobra (STN). */ + Stn = 'STN', + /** Syrian Pound (SYP). */ + Syp = 'SYP', + /** Swazi Lilangeni (SZL). */ + Szl = 'SZL', /** Thai baht (THB). */ Thb = 'THB', - /** Tanzanian Shilling (TZS). */ - Tzs = 'TZS', - /** Trinidad and Tobago Dollars (TTD). */ - Ttd = 'TTD', - /** Tunisian Dinar (TND). */ - Tnd = 'TND', - /** Turkish Lira (TRY). */ - Try = 'TRY', + /** Tajikistani Somoni (TJS). */ + Tjs = 'TJS', /** Turkmenistani Manat (TMT). */ Tmt = 'TMT', - /** Ugandan Shilling (UGX). */ - Ugx = 'UGX', + /** Tunisian Dinar (TND). */ + Tnd = 'TND', + /** Tongan Pa'anga (TOP). */ + Top = 'TOP', + /** Turkish Lira (TRY). */ + Try = 'TRY', + /** Trinidad and Tobago Dollars (TTD). */ + Ttd = 'TTD', + /** Taiwan Dollars (TWD). */ + Twd = 'TWD', + /** Tanzanian Shilling (TZS). */ + Tzs = 'TZS', /** Ukrainian Hryvnia (UAH). */ Uah = 'UAH', - /** United Arab Emirates Dirham (AED). */ - Aed = 'AED', + /** Ugandan Shilling (UGX). */ + Ugx = 'UGX', + /** United States Dollars (USD). */ + Usd = 'USD', /** Uruguayan Pesos (UYU). */ Uyu = 'UYU', /** Uzbekistan som (UZS). */ Uzs = 'UZS', - /** Vanuatu Vatu (VUV). */ - Vuv = 'VUV', - /** Vietnamese đồng (VND). */ - Vnd = 'VND', - /** West African CFA franc (XOF). */ - Xof = 'XOF', - /** Yemeni Rial (YER). */ - Yer = 'YER', - /** Zambian Kwacha (ZMW). */ - Zmw = 'ZMW', - /** Belarusian Ruble (BYN). */ - Byn = 'BYN', - /** Belarusian Ruble (BYR). */ - Byr = 'BYR', - /** Djiboutian Franc (DJF). */ - Djf = 'DJF', - /** Eritrean Nakfa (ERN). */ - Ern = 'ERN', - /** Falkland Islands Pounds (FKP). */ - Fkp = 'FKP', - /** Gibraltar Pounds (GIP). */ - Gip = 'GIP', - /** Guinean Franc (GNF). */ - Gnf = 'GNF', - /** Iranian Rial (IRR). */ - Irr = 'IRR', - /** Kiribati Dollar (KID). */ - Kid = 'KID', - /** Libyan Dinar (LYD). */ - Lyd = 'LYD', - /** Mauritanian Ouguiya (MRU). */ - Mru = 'MRU', - /** Sierra Leonean Leone (SLL). */ - Sll = 'SLL', - /** Saint Helena Pounds (SHP). */ - Shp = 'SHP', - /** Somali Shilling (SOS). */ - Sos = 'SOS', - /** Tajikistani Somoni (TJS). */ - Tjs = 'TJS', - /** Tongan Pa'anga (TOP). */ - Top = 'TOP', - /** Venezuelan Bolivares (VEF). */ + /** Venezuelan Bolivares (VED). */ + Ved = 'VED', + /** + * Venezuelan Bolivares (VEF). + * @deprecated `VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead. + */ Vef = 'VEF', /** Venezuelan Bolivares (VES). */ Ves = 'VES', + /** Vietnamese đồng (VND). */ + Vnd = 'VND', + /** Vanuatu Vatu (VUV). */ + Vuv = 'VUV', + /** Samoan Tala (WST). */ + Wst = 'WST', + /** Central African CFA Franc (XAF). */ + Xaf = 'XAF', + /** East Caribbean Dollar (XCD). */ + Xcd = 'XCD', + /** West African CFA franc (XOF). */ + Xof = 'XOF', + /** CFP Franc (XPF). */ + Xpf = 'XPF', + /** Unrecognized currency. */ + Xxx = 'XXX', + /** Yemeni Rial (YER). */ + Yer = 'YER', + /** South African Rand (ZAR). */ + Zar = 'ZAR', + /** Zambian Kwacha (ZMW). */ + Zmw = 'ZMW', } /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ -export type Customer = { +export type Customer = HasMetafields & { __typename?: 'Customer' /** Indicates whether the customer has consented to be sent marketing material via email. */ acceptsMarketing: Scalars['Boolean'] @@ -2075,6 +2545,13 @@ export type Customer = { lastIncompleteCheckout?: Maybe /** The customer’s last name. */ lastName?: Maybe + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> /** The orders associated with the customer. */ orders: OrderConnection /** The customer’s phone number. */ @@ -2082,6 +2559,7 @@ export type Customer = { /** * A comma separated list of tags that have been added to the customer. * Additional access scope required: unauthenticated_read_customer_tags. + * */ tags: Array /** The date and time when the customer information was updated. */ @@ -2090,22 +2568,33 @@ export type Customer = { /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerAddressesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] +} + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerMetafieldsArgs = { + identifiers: Array } /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerOrdersArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } /** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ @@ -2130,11 +2619,11 @@ export type CustomerAccessTokenCreatePayload = { __typename?: 'CustomerAccessTokenCreatePayload' /** The newly created customer access token object. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2144,7 +2633,7 @@ export type CustomerAccessTokenCreateWithMultipassPayload = { __typename?: 'CustomerAccessTokenCreateWithMultipassPayload' /** An access token object associated with the customer. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array } @@ -2155,7 +2644,7 @@ export type CustomerAccessTokenDeletePayload = { deletedAccessToken?: Maybe /** ID of the destroyed customer access token. */ deletedCustomerAccessTokenId?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ userErrors: Array } @@ -2164,7 +2653,7 @@ export type CustomerAccessTokenRenewPayload = { __typename?: 'CustomerAccessTokenRenewPayload' /** The renewed customer access token object. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ userErrors: Array } @@ -2175,7 +2664,7 @@ export type CustomerActivateByUrlPayload = { customer?: Maybe /** A new customer access token for the customer. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array } @@ -2194,11 +2683,11 @@ export type CustomerActivatePayload = { customer?: Maybe /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2208,11 +2697,11 @@ export type CustomerAddressCreatePayload = { __typename?: 'CustomerAddressCreatePayload' /** The new customer address object. */ customerAddress?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2220,13 +2709,13 @@ export type CustomerAddressCreatePayload = { /** Return type for `customerAddressDelete` mutation. */ export type CustomerAddressDeletePayload = { __typename?: 'CustomerAddressDeletePayload' - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** ID of the deleted customer address. */ deletedCustomerAddressId?: Maybe /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2236,33 +2725,34 @@ export type CustomerAddressUpdatePayload = { __typename?: 'CustomerAddressUpdatePayload' /** The customer’s updated mailing address. */ customerAddress?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } -/** Specifies the fields required to create a new customer. */ +/** The fields required to create a new customer. */ export type CustomerCreateInput = { - /** The customer’s first name. */ - firstName?: Maybe - /** The customer’s last name. */ - lastName?: Maybe + /** Indicates whether the customer has consented to be sent marketing material via email. */ + acceptsMarketing?: InputMaybe /** The customer’s email. */ email: Scalars['String'] + /** The customer’s first name. */ + firstName?: InputMaybe + /** The customer’s last name. */ + lastName?: InputMaybe + /** The login password used by the customer. */ + password: Scalars['String'] /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ - phone?: Maybe - /** The login password used by the customer. */ - password: Scalars['String'] - /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: Maybe + phone?: InputMaybe } /** Return type for `customerCreate` mutation. */ @@ -2270,11 +2760,11 @@ export type CustomerCreatePayload = { __typename?: 'CustomerCreatePayload' /** The created customer object. */ customer?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2284,57 +2774,57 @@ export type CustomerDefaultAddressUpdatePayload = { __typename?: 'CustomerDefaultAddressUpdatePayload' /** The updated customer object. */ customer?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } -/** Possible error codes that could be returned by CustomerUserError. */ +/** Possible error codes that can be returned by `CustomerUserError`. */ export enum CustomerErrorCode { - /** Input value is blank. */ + /** Customer already enabled. */ + AlreadyEnabled = 'ALREADY_ENABLED', + /** Input email contains an invalid domain name. */ + BadDomain = 'BAD_DOMAIN', + /** The input value is blank. */ Blank = 'BLANK', - /** Input value is invalid. */ - Invalid = 'INVALID', - /** Input value is already taken. */ - Taken = 'TAKEN', - /** Input value is too long. */ - TooLong = 'TOO_LONG', - /** Input value is too short. */ - TooShort = 'TOO_SHORT', - /** Unidentified customer. */ - UnidentifiedCustomer = 'UNIDENTIFIED_CUSTOMER', - /** Customer is disabled. */ - CustomerDisabled = 'CUSTOMER_DISABLED', - /** Input password starts or ends with whitespace. */ - PasswordStartsOrEndsWithWhitespace = 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE', /** Input contains HTML tags. */ ContainsHtmlTags = 'CONTAINS_HTML_TAGS', /** Input contains URL. */ ContainsUrl = 'CONTAINS_URL', - /** Invalid activation token. */ - TokenInvalid = 'TOKEN_INVALID', - /** Customer already enabled. */ - AlreadyEnabled = 'ALREADY_ENABLED', - /** Address does not exist. */ - NotFound = 'NOT_FOUND', - /** Input email contains an invalid domain name. */ - BadDomain = 'BAD_DOMAIN', + /** Customer is disabled. */ + CustomerDisabled = 'CUSTOMER_DISABLED', + /** The input value is invalid. */ + Invalid = 'INVALID', /** Multipass token is not valid. */ InvalidMultipassRequest = 'INVALID_MULTIPASS_REQUEST', + /** Address does not exist. */ + NotFound = 'NOT_FOUND', + /** Input password starts or ends with whitespace. */ + PasswordStartsOrEndsWithWhitespace = 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE', + /** The input value is already taken. */ + Taken = 'TAKEN', + /** Invalid activation token. */ + TokenInvalid = 'TOKEN_INVALID', + /** The input value is too long. */ + TooLong = 'TOO_LONG', + /** The input value is too short. */ + TooShort = 'TOO_SHORT', + /** Unidentified customer. */ + UnidentifiedCustomer = 'UNIDENTIFIED_CUSTOMER', } /** Return type for `customerRecover` mutation. */ export type CustomerRecoverPayload = { __typename?: 'CustomerRecoverPayload' - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2346,21 +2836,21 @@ export type CustomerResetByUrlPayload = { customer?: Maybe /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } /** Specifies the fields required to reset a customer’s password. */ export type CustomerResetInput = { - /** The reset token required to reset the customer’s password. */ - resetToken: Scalars['String'] /** New password that will be set as part of the reset password process. */ password: Scalars['String'] + /** The reset token required to reset the customer’s password. */ + resetToken: Scalars['String'] } /** Return type for `customerReset` mutation. */ @@ -2370,33 +2860,34 @@ export type CustomerResetPayload = { customer?: Maybe /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } /** Specifies the fields required to update the Customer information. */ export type CustomerUpdateInput = { - /** The customer’s first name. */ - firstName?: Maybe - /** The customer’s last name. */ - lastName?: Maybe + /** Indicates whether the customer has consented to be sent marketing material via email. */ + acceptsMarketing?: InputMaybe /** The customer’s email. */ - email?: Maybe + email?: InputMaybe + /** The customer’s first name. */ + firstName?: InputMaybe + /** The customer’s last name. */ + lastName?: InputMaybe + /** The login password used by the customer. */ + password?: InputMaybe /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. + * */ - phone?: Maybe - /** The login password used by the customer. */ - password?: Maybe - /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: Maybe + phone?: InputMaybe } /** Return type for `customerUpdate` mutation. */ @@ -2407,13 +2898,14 @@ export type CustomerUpdatePayload = { /** * The newly created customer access token. If the customer's password is updated, all previous access tokens * (including the one used to perform this mutation) become invalid, and a new token is generated. + * */ customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ + /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. */ userErrors: Array } @@ -2421,27 +2913,46 @@ export type CustomerUpdatePayload = { /** Represents an error that happens during execution of a customer mutation. */ export type CustomerUserError = DisplayableError & { __typename?: 'CustomerUserError' - /** Error code to uniquely identify the error. */ + /** The error code. */ code?: Maybe - /** Path to the input field which caused the error. */ + /** The path to the input field that caused the error. */ field?: Maybe> /** The error message. */ message: Scalars['String'] } +/** List of different delivery method types. */ +export enum DeliveryMethodType { + /** Local Delivery. */ + Local = 'LOCAL', + /** None. */ + None = 'NONE', + /** Shipping to a Pickup Point. */ + PickupPoint = 'PICKUP_POINT', + /** Local Pickup. */ + PickUp = 'PICK_UP', + /** Retail. */ + Retail = 'RETAIL', + /** Shipping. */ + Shipping = 'SHIPPING', +} + /** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ export enum DigitalWallet { - /** Apple Pay. */ - ApplePay = 'APPLE_PAY', /** Android Pay. */ AndroidPay = 'ANDROID_PAY', + /** Apple Pay. */ + ApplePay = 'APPLE_PAY', /** Google Pay. */ GooglePay = 'GOOGLE_PAY', /** Shopify Pay. */ ShopifyPay = 'SHOPIFY_PAY', } -/** An amount discounting the line that has been allocated by a discount. */ +/** + * An amount discounting the line that has been allocated by a discount. + * + */ export type DiscountAllocation = { __typename?: 'DiscountAllocation' /** Amount of discount allocated. */ @@ -2453,6 +2964,7 @@ export type DiscountAllocation = { /** * Discount applications capture the intentions of a discount source at * the time of application. + * */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ @@ -2471,20 +2983,31 @@ export enum DiscountApplicationAllocationMethod { Across = 'ACROSS', /** The value is applied onto every entitled line. */ Each = 'EACH', - /** The value is specifically applied onto a particular line. */ + /** + * The value is specifically applied onto a particular line. + * @deprecated Use ACROSS instead. + */ One = 'ONE', } -/** An auto-generated type for paginating through multiple DiscountApplications. */ +/** + * An auto-generated type for paginating through multiple DiscountApplications. + * + */ export type DiscountApplicationConnection = { __typename?: 'DiscountApplicationConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in DiscountApplicationEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */ +/** + * An auto-generated type which holds one DiscountApplication and a cursor during pagination. + * + */ export type DiscountApplicationEdge = { __typename?: 'DiscountApplicationEdge' /** A cursor for use in pagination. */ @@ -2494,19 +3017,25 @@ export type DiscountApplicationEdge = { } /** - * Which lines on the order that the discount is allocated over, of the type - * defined by the Discount Application's target_type. + * The lines on the order to which the discount is applied, of the type defined by + * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of + * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. + * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. + * */ export enum DiscountApplicationTargetSelection { /** The discount is allocated onto all the lines. */ All = 'ALL', - /** The discount is allocated onto only the lines it is entitled for. */ + /** The discount is allocated onto only the lines that it's entitled for. */ Entitled = 'ENTITLED', /** The discount is allocated onto explicitly chosen lines. */ Explicit = 'EXPLICIT', } -/** The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. */ +/** + * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. + * + */ export enum DiscountApplicationTargetType { /** The discount applies onto line items. */ LineItem = 'LINE_ITEM', @@ -2517,6 +3046,7 @@ export enum DiscountApplicationTargetType { /** * Discount code applications capture the intentions of a discount code at * the time that it is applied. + * */ export type DiscountCodeApplication = DiscountApplication & { __typename?: 'DiscountCodeApplication' @@ -2536,7 +3066,7 @@ export type DiscountCodeApplication = DiscountApplication & { /** Represents an error in the input of a mutation. */ export type DisplayableError = { - /** Path to the input field which caused the error. */ + /** The path to the input field that caused the error. */ field?: Maybe> /** The error message. */ message: Scalars['String'] @@ -2554,21 +3084,77 @@ export type Domain = { } /** Represents a video hosted outside of Shopify. */ -export type ExternalVideo = Node & - Media & { +export type ExternalVideo = Media & + Node & { __typename?: 'ExternalVideo' /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe - /** The URL. */ + /** The embed URL of the video for the respective host. */ + embedUrl: Scalars['URL'] + /** + * The URL. + * @deprecated Use `originUrl` instead. + */ embeddedUrl: Scalars['URL'] - /** Globally unique identifier. */ + /** The host of the external video. */ + host: MediaHost + /** A globally-unique identifier. */ id: Scalars['ID'] /** The media content type. */ mediaContentType: MediaContentType + /** The origin URL of the video on the respective host. */ + originUrl: Scalars['URL'] /** The preview image for the media. */ previewImage?: Maybe } +/** A filter that is supported on the parent field. */ +export type Filter = { + __typename?: 'Filter' + /** A unique identifier. */ + id: Scalars['String'] + /** A human-friendly string for this filter. */ + label: Scalars['String'] + /** An enumeration that denotes the type of data this filter represents. */ + type: FilterType + /** The list of values for this filter. */ + values: Array +} + +/** + * The type of data that the filter group represents. + * + * For more information, refer to [Filter products in a collection with the Storefront API] + * (https://shopify.dev/api/examples/filter-products). + * + */ +export enum FilterType { + /** A boolean value. */ + Boolean = 'BOOLEAN', + /** A list of selectable values. */ + List = 'LIST', + /** A range of prices. */ + PriceRange = 'PRICE_RANGE', +} + +/** A selectable value within a filter. */ +export type FilterValue = { + __typename?: 'FilterValue' + /** The number of results that match this filter value. */ + count: Scalars['Int'] + /** A unique identifier. */ + id: Scalars['String'] + /** + * An input object that can be used to filter by this value on the parent field. + * + * The value is provided as a helper for building dynamic filtering UI. For example, if you have a list of selected `FilterValue` objects, you can combine their respective `input` values to use in a subsequent query. + * + */ + input: Scalars['JSON'] + /** A human-friendly string for this filter value. */ + label: Scalars['String'] +} + /** Represents a single fulfillment in an order. */ export type Fulfillment = { __typename?: 'Fulfillment' @@ -2579,22 +3165,23 @@ export type Fulfillment = { /** * Tracking information associated with the fulfillment, * such as the tracking number and tracking URL. + * */ trackingInfo: Array } /** Represents a single fulfillment in an order. */ export type FulfillmentFulfillmentLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** Represents a single fulfillment in an order. */ export type FulfillmentTrackingInfoArgs = { - first?: Maybe + first?: InputMaybe } /** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ @@ -2606,16 +3193,24 @@ export type FulfillmentLineItem = { quantity: Scalars['Int'] } -/** An auto-generated type for paginating through multiple FulfillmentLineItems. */ +/** + * An auto-generated type for paginating through multiple FulfillmentLineItems. + * + */ export type FulfillmentLineItemConnection = { __typename?: 'FulfillmentLineItemConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in FulfillmentLineItemEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */ +/** + * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. + * + */ export type FulfillmentLineItemEdge = { __typename?: 'FulfillmentLineItemEdge' /** A cursor for use in pagination. */ @@ -2633,28 +3228,59 @@ export type FulfillmentTrackingInfo = { url?: Maybe } +/** The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. */ +export type GenericFile = Node & { + __typename?: 'GenericFile' + /** A word or phrase to indicate the contents of a file. */ + alt?: Maybe + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The MIME type of the file. */ + mimeType?: Maybe + /** The size of the original file in bytes. */ + originalFileSize?: Maybe + /** The preview image for the file. */ + previewImage?: Maybe + /** The URL of the file. */ + url?: Maybe +} + +/** Used to specify a geographical location. */ +export type GeoCoordinateInput = { + /** The coordinate's latitude value. */ + latitude: Scalars['Float'] + /** The coordinate's longitude value. */ + longitude: Scalars['Float'] +} + /** Represents information about the metafields associated to the specified resource. */ export type HasMetafields = { - /** The metafield associated with the resource. */ + /** Returns a metafield found by namespace and key. */ metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> } /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldArgs = { - namespace: Scalars['String'] key: Scalars['String'] + namespace: Scalars['String'] } /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + identifiers: Array +} + +/** Identifies a metafield on an owner resource by namespace and key. */ +export type HasMetafieldsIdentifier = { + /** The identifier for the metafield. */ + key: Scalars['String'] + /** A container for a set of metafields. */ + namespace: Scalars['String'] } /** Represents an image resource. */ @@ -2670,52 +3296,13 @@ export type Image = { * The location of the original image as a URL. * * If there are any existing transformations in the original source URL, they will remain and not be stripped. + * + * @deprecated Use `url` instead. */ originalSrc: Scalars['URL'] /** * The location of the image as a URL. - * @deprecated Previously an image had a single `src` field. This could either return the original image - * location or a URL that contained transformations such as sizing or scale. - * - * These transformations were specified by arguments on the parent field. - * - * Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. - * - * * `originalSrc` - the original unmodified image URL - * * `transformedSrc` - the image URL with the specified transformations included - * - * To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. - * - * Before: - * ```graphql - * { - * shop { - * productImages(maxWidth: 200, scale: 2) { - * edges { - * node { - * src - * } - * } - * } - * } - * } - * ``` - * - * After: - * ```graphql - * { - * shop { - * productImages { - * edges { - * node { - * transformedSrc(maxWidth: 200, scale: 2) - * } - * } - * } - * } - * } - * ``` - * + * @deprecated Use `url` instead. */ src: Scalars['URL'] /** @@ -2723,41 +3310,67 @@ export type Image = { * * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. * Otherwise any transformations which an image type does not support will be ignored. + * + * @deprecated Use `url(transform:)` instead */ transformedSrc: Scalars['URL'] + /** + * The location of the image as a URL. + * + * If no transform options are specified, then the original image will be preserved including any pre-applied transforms. + * + * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. + * + * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). + * + */ + url: Scalars['URL'] /** The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify. */ width?: Maybe } /** Represents an image resource. */ export type ImageTransformedSrcArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe - preferredContentType?: Maybe + crop?: InputMaybe + maxHeight?: InputMaybe + maxWidth?: InputMaybe + preferredContentType?: InputMaybe + scale?: InputMaybe } -/** An auto-generated type for paginating through multiple Images. */ +/** Represents an image resource. */ +export type ImageUrlArgs = { + transform?: InputMaybe +} + +/** + * An auto-generated type for paginating through multiple Images. + * + */ export type ImageConnection = { __typename?: 'ImageConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in ImageEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } /** List of supported image content types. */ export enum ImageContentType { - /** A PNG image. */ - Png = 'PNG', /** A JPG image. */ Jpg = 'JPG', + /** A PNG image. */ + Png = 'PNG', /** A WEBP image. */ Webp = 'WEBP', } -/** An auto-generated type which holds one Image and a cursor during pagination. */ +/** + * An auto-generated type which holds one Image and a cursor during pagination. + * + */ export type ImageEdge = { __typename?: 'ImageEdge' /** A cursor for use in pagination. */ @@ -2766,30 +3379,469 @@ export type ImageEdge = { node: Image } +/** + * The available options for transforming an image. + * + * All transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored. + * + */ +export type ImageTransformInput = { + /** + * The region of the image to remain after cropping. + * Must be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal. + * The `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while + * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result + * in an image with a width of 5 and height of 10, where the right side of the image is removed. + * + */ + crop?: InputMaybe + /** + * Image height in pixels between 1 and 5760. + * + */ + maxHeight?: InputMaybe + /** + * Image width in pixels between 1 and 5760. + * + */ + maxWidth?: InputMaybe + /** + * Convert the source image into the preferred content type. + * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. + * + */ + preferredContentType?: InputMaybe + /** + * Image size multiplier for high-resolution retina displays. Must be within 1..3. + * + */ + scale?: InputMaybe +} + +/** A language. */ +export type Language = { + __typename?: 'Language' + /** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */ + endonymName: Scalars['String'] + /** The ISO code. */ + isoCode: LanguageCode + /** The name of the language in the current language. */ + name: Scalars['String'] +} + +/** ISO 639-1 language codes supported by Shopify. */ +export enum LanguageCode { + /** Afrikaans. */ + Af = 'AF', + /** Akan. */ + Ak = 'AK', + /** Amharic. */ + Am = 'AM', + /** Arabic. */ + Ar = 'AR', + /** Assamese. */ + As = 'AS', + /** Azerbaijani. */ + Az = 'AZ', + /** Belarusian. */ + Be = 'BE', + /** Bulgarian. */ + Bg = 'BG', + /** Bambara. */ + Bm = 'BM', + /** Bangla. */ + Bn = 'BN', + /** Tibetan. */ + Bo = 'BO', + /** Breton. */ + Br = 'BR', + /** Bosnian. */ + Bs = 'BS', + /** Catalan. */ + Ca = 'CA', + /** Chechen. */ + Ce = 'CE', + /** Czech. */ + Cs = 'CS', + /** Church Slavic. */ + Cu = 'CU', + /** Welsh. */ + Cy = 'CY', + /** Danish. */ + Da = 'DA', + /** German. */ + De = 'DE', + /** Dzongkha. */ + Dz = 'DZ', + /** Ewe. */ + Ee = 'EE', + /** Greek. */ + El = 'EL', + /** English. */ + En = 'EN', + /** Esperanto. */ + Eo = 'EO', + /** Spanish. */ + Es = 'ES', + /** Estonian. */ + Et = 'ET', + /** Basque. */ + Eu = 'EU', + /** Persian. */ + Fa = 'FA', + /** Fulah. */ + Ff = 'FF', + /** Finnish. */ + Fi = 'FI', + /** Faroese. */ + Fo = 'FO', + /** French. */ + Fr = 'FR', + /** Western Frisian. */ + Fy = 'FY', + /** Irish. */ + Ga = 'GA', + /** Scottish Gaelic. */ + Gd = 'GD', + /** Galician. */ + Gl = 'GL', + /** Gujarati. */ + Gu = 'GU', + /** Manx. */ + Gv = 'GV', + /** Hausa. */ + Ha = 'HA', + /** Hebrew. */ + He = 'HE', + /** Hindi. */ + Hi = 'HI', + /** Croatian. */ + Hr = 'HR', + /** Hungarian. */ + Hu = 'HU', + /** Armenian. */ + Hy = 'HY', + /** Interlingua. */ + Ia = 'IA', + /** Indonesian. */ + Id = 'ID', + /** Igbo. */ + Ig = 'IG', + /** Sichuan Yi. */ + Ii = 'II', + /** Icelandic. */ + Is = 'IS', + /** Italian. */ + It = 'IT', + /** Japanese. */ + Ja = 'JA', + /** Javanese. */ + Jv = 'JV', + /** Georgian. */ + Ka = 'KA', + /** Kikuyu. */ + Ki = 'KI', + /** Kazakh. */ + Kk = 'KK', + /** Kalaallisut. */ + Kl = 'KL', + /** Khmer. */ + Km = 'KM', + /** Kannada. */ + Kn = 'KN', + /** Korean. */ + Ko = 'KO', + /** Kashmiri. */ + Ks = 'KS', + /** Kurdish. */ + Ku = 'KU', + /** Cornish. */ + Kw = 'KW', + /** Kyrgyz. */ + Ky = 'KY', + /** Luxembourgish. */ + Lb = 'LB', + /** Ganda. */ + Lg = 'LG', + /** Lingala. */ + Ln = 'LN', + /** Lao. */ + Lo = 'LO', + /** Lithuanian. */ + Lt = 'LT', + /** Luba-Katanga. */ + Lu = 'LU', + /** Latvian. */ + Lv = 'LV', + /** Malagasy. */ + Mg = 'MG', + /** Māori. */ + Mi = 'MI', + /** Macedonian. */ + Mk = 'MK', + /** Malayalam. */ + Ml = 'ML', + /** Mongolian. */ + Mn = 'MN', + /** Marathi. */ + Mr = 'MR', + /** Malay. */ + Ms = 'MS', + /** Maltese. */ + Mt = 'MT', + /** Burmese. */ + My = 'MY', + /** Norwegian (Bokmål). */ + Nb = 'NB', + /** North Ndebele. */ + Nd = 'ND', + /** Nepali. */ + Ne = 'NE', + /** Dutch. */ + Nl = 'NL', + /** Norwegian Nynorsk. */ + Nn = 'NN', + /** Norwegian. */ + No = 'NO', + /** Oromo. */ + Om = 'OM', + /** Odia. */ + Or = 'OR', + /** Ossetic. */ + Os = 'OS', + /** Punjabi. */ + Pa = 'PA', + /** Polish. */ + Pl = 'PL', + /** Pashto. */ + Ps = 'PS', + /** Portuguese. */ + Pt = 'PT', + /** Portuguese (Brazil). */ + PtBr = 'PT_BR', + /** Portuguese (Portugal). */ + PtPt = 'PT_PT', + /** Quechua. */ + Qu = 'QU', + /** Romansh. */ + Rm = 'RM', + /** Rundi. */ + Rn = 'RN', + /** Romanian. */ + Ro = 'RO', + /** Russian. */ + Ru = 'RU', + /** Kinyarwanda. */ + Rw = 'RW', + /** Sindhi. */ + Sd = 'SD', + /** Northern Sami. */ + Se = 'SE', + /** Sango. */ + Sg = 'SG', + /** Sinhala. */ + Si = 'SI', + /** Slovak. */ + Sk = 'SK', + /** Slovenian. */ + Sl = 'SL', + /** Shona. */ + Sn = 'SN', + /** Somali. */ + So = 'SO', + /** Albanian. */ + Sq = 'SQ', + /** Serbian. */ + Sr = 'SR', + /** Sundanese. */ + Su = 'SU', + /** Swedish. */ + Sv = 'SV', + /** Swahili. */ + Sw = 'SW', + /** Tamil. */ + Ta = 'TA', + /** Telugu. */ + Te = 'TE', + /** Tajik. */ + Tg = 'TG', + /** Thai. */ + Th = 'TH', + /** Tigrinya. */ + Ti = 'TI', + /** Turkmen. */ + Tk = 'TK', + /** Tongan. */ + To = 'TO', + /** Turkish. */ + Tr = 'TR', + /** Tatar. */ + Tt = 'TT', + /** Uyghur. */ + Ug = 'UG', + /** Ukrainian. */ + Uk = 'UK', + /** Urdu. */ + Ur = 'UR', + /** Uzbek. */ + Uz = 'UZ', + /** Vietnamese. */ + Vi = 'VI', + /** Volapük. */ + Vo = 'VO', + /** Wolof. */ + Wo = 'WO', + /** Xhosa. */ + Xh = 'XH', + /** Yiddish. */ + Yi = 'YI', + /** Yoruba. */ + Yo = 'YO', + /** Chinese. */ + Zh = 'ZH', + /** Chinese (Simplified). */ + ZhCn = 'ZH_CN', + /** Chinese (Traditional). */ + ZhTw = 'ZH_TW', + /** Zulu. */ + Zu = 'ZU', +} + +/** Information about the localized experiences configured for the shop. */ +export type Localization = { + __typename?: 'Localization' + /** The list of countries with enabled localized experiences. */ + availableCountries: Array + /** The list of languages available for the active country. */ + availableLanguages: Array + /** The country of the active localized experience. Use the `@inContext` directive to change this value. */ + country: Country + /** The language of the active localized experience. Use the `@inContext` directive to change this value. */ + language: Language +} + +/** Represents a location where product inventory is held. */ +export type Location = Node & { + __typename?: 'Location' + /** The address of the location. */ + address: LocationAddress + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The name of the location. */ + name: Scalars['String'] +} + +/** + * Represents the address of a location. + * + */ +export type LocationAddress = { + __typename?: 'LocationAddress' + /** The first line of the address for the location. */ + address1?: Maybe + /** The second line of the address for the location. */ + address2?: Maybe + /** The city of the location. */ + city?: Maybe + /** The country of the location. */ + country?: Maybe + /** The country code of the location. */ + countryCode?: Maybe + /** A formatted version of the address for the location. */ + formatted: Array + /** The latitude coordinates of the location. */ + latitude?: Maybe + /** The longitude coordinates of the location. */ + longitude?: Maybe + /** The phone number of the location. */ + phone?: Maybe + /** The province of the location. */ + province?: Maybe + /** + * The code for the province, state, or district of the address of the location. + * + */ + provinceCode?: Maybe + /** The ZIP code of the location. */ + zip?: Maybe +} + +/** + * An auto-generated type for paginating through multiple Locations. + * + */ +export type LocationConnection = { + __typename?: 'LocationConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in LocationEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one Location and a cursor during pagination. + * + */ +export type LocationEdge = { + __typename?: 'LocationEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of LocationEdge. */ + node: Location +} + +/** The set of valid sort keys for the Location query. */ +export enum LocationSortKeys { + /** Sort by the `city` value. */ + City = 'CITY', + /** Sort by the `distance` value. */ + Distance = 'DISTANCE', + /** Sort by the `id` value. */ + Id = 'ID', + /** Sort by the `name` value. */ + Name = 'NAME', +} + /** Represents a mailing address for customers and shipping. */ export type MailingAddress = Node & { __typename?: 'MailingAddress' /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe - /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + * + */ address2?: Maybe - /** The name of the city, district, village, or town. */ + /** + * The name of the city, district, village, or town. + * + */ city?: Maybe - /** The name of the customer's company or organization. */ + /** + * The name of the customer's company or organization. + * + */ company?: Maybe - /** The name of the country. */ + /** + * The name of the country. + * + */ country?: Maybe /** * The two-letter code for the country of the address. * * For example, US. - * @deprecated Use `countryCodeV2` instead + * + * @deprecated Use `countryCodeV2` instead. */ countryCode?: Maybe /** * The two-letter code for the country of the address. * * For example, US. + * */ countryCodeV2?: Maybe /** The first name of the customer. */ @@ -2798,7 +3850,7 @@ export type MailingAddress = Node & { formatted: Array /** A comma-separated list of the values for city, province, and country. */ formattedArea?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The last name of the customer. */ lastName?: Maybe @@ -2806,12 +3858,16 @@ export type MailingAddress = Node & { latitude?: Maybe /** The longitude coordinate of the customer address. */ longitude?: Maybe - /** The full name of the customer, based on firstName and lastName. */ + /** + * The full name of the customer, based on firstName and lastName. + * + */ name?: Maybe /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ phone?: Maybe /** The region of the address, such as the province, state, or district. */ @@ -2820,6 +3876,7 @@ export type MailingAddress = Node & { * The two-letter code for the region. * * For example, ON. + * */ provinceCode?: Maybe /** The zip or postal code of the address. */ @@ -2828,20 +3885,28 @@ export type MailingAddress = Node & { /** Represents a mailing address for customers and shipping. */ export type MailingAddressFormattedArgs = { - withName?: Maybe - withCompany?: Maybe + withCompany?: InputMaybe + withName?: InputMaybe } -/** An auto-generated type for paginating through multiple MailingAddresses. */ +/** + * An auto-generated type for paginating through multiple MailingAddresses. + * + */ export type MailingAddressConnection = { __typename?: 'MailingAddressConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in MailingAddressEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one MailingAddress and a cursor during pagination. */ +/** + * An auto-generated type which holds one MailingAddress and a cursor during pagination. + * + */ export type MailingAddressEdge = { __typename?: 'MailingAddressEdge' /** A cursor for use in pagination. */ @@ -2852,33 +3917,49 @@ export type MailingAddressEdge = { /** Specifies the fields accepted to create or update a mailing address. */ export type MailingAddressInput = { - /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe - /** The second line of the address. Typically the number of the apartment, suite, or unit. */ - address2?: Maybe - /** The name of the city, district, village, or town. */ - city?: Maybe - /** The name of the customer's company or organization. */ - company?: Maybe + /** + * The first line of the address. Typically the street address or PO Box number. + * + */ + address1?: InputMaybe + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + * + */ + address2?: InputMaybe + /** + * The name of the city, district, village, or town. + * + */ + city?: InputMaybe + /** + * The name of the customer's company or organization. + * + */ + company?: InputMaybe /** The name of the country. */ - country?: Maybe + country?: InputMaybe /** The first name of the customer. */ - firstName?: Maybe + firstName?: InputMaybe /** The last name of the customer. */ - lastName?: Maybe + lastName?: InputMaybe /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ - phone?: Maybe + phone?: InputMaybe /** The region of the address, such as the province, state, or district. */ - province?: Maybe + province?: InputMaybe /** The zip or postal code of the address. */ - zip?: Maybe + zip?: InputMaybe } -/** Manual discount applications capture the intentions of a discount that was manually created. */ +/** + * Manual discount applications capture the intentions of a discount that was manually created. + * + */ export type ManualDiscountApplication = DiscountApplication & { __typename?: 'ManualDiscountApplication' /** The method by which the discount's value is allocated to its entitled items. */ @@ -2905,11 +3986,16 @@ export type Media = { previewImage?: Maybe } -/** An auto-generated type for paginating through multiple Media. */ +/** + * An auto-generated type for paginating through multiple Media. + * + */ export type MediaConnection = { __typename?: 'MediaConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in MediaEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } @@ -2926,7 +4012,10 @@ export enum MediaContentType { Video = 'VIDEO', } -/** An auto-generated type which holds one Media and a cursor during pagination. */ +/** + * An auto-generated type which holds one Media and a cursor during pagination. + * + */ export type MediaEdge = { __typename?: 'MediaEdge' /** A cursor for use in pagination. */ @@ -2935,13 +4024,21 @@ export type MediaEdge = { node: Media } +/** Host for a Media Resource. */ +export enum MediaHost { + /** Host for Vimeo embedded videos. */ + Vimeo = 'VIMEO', + /** Host for YouTube embedded videos. */ + Youtube = 'YOUTUBE', +} + /** Represents a Shopify hosted image. */ -export type MediaImage = Node & - Media & { +export type MediaImage = Media & + Node & { __typename?: 'MediaImage' /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The image for the media. */ image?: Maybe @@ -2951,9 +4048,79 @@ export type MediaImage = Node & previewImage?: Maybe } +/** + * A menu used for navigation within a storefront. + * + */ +export type Menu = Node & { + __typename?: 'Menu' + /** The menu's handle. */ + handle: Scalars['String'] + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The menu's child items. */ + items: Array + /** The count of items on the menu. */ + itemsCount: Scalars['Int'] + /** The menu's title. */ + title: Scalars['String'] +} + +/** + * A menu item within a parent menu. + * + */ +export type MenuItem = Node & { + __typename?: 'MenuItem' + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The menu item's child items. */ + items: Array + /** The ID of the linked resource. */ + resourceId?: Maybe + /** The menu item's tags to filter a collection. */ + tags: Array + /** The menu item's title. */ + title: Scalars['String'] + /** The menu item's type. */ + type: MenuItemType + /** The menu item's URL. */ + url?: Maybe +} + +/** A menu item type. */ +export enum MenuItemType { + /** An article link. */ + Article = 'ARTICLE', + /** A blog link. */ + Blog = 'BLOG', + /** A catalog link. */ + Catalog = 'CATALOG', + /** A collection link. */ + Collection = 'COLLECTION', + /** A collection link. */ + Collections = 'COLLECTIONS', + /** A frontpage link. */ + Frontpage = 'FRONTPAGE', + /** An http link. */ + Http = 'HTTP', + /** A page link. */ + Page = 'PAGE', + /** A product link. */ + Product = 'PRODUCT', + /** A search link. */ + Search = 'SEARCH', + /** A shop policy link. */ + ShopPolicy = 'SHOP_POLICY', +} + +/** The merchandise to be purchased at checkout. */ +export type Merchandise = ProductVariant + /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. + * */ export type Metafield = Node & { __typename?: 'Metafield' @@ -2961,7 +4128,7 @@ export type Metafield = Node & { createdAt: Scalars['DateTime'] /** The description of a metafield. */ description?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The key name for a metafield. */ key: Scalars['String'] @@ -2969,52 +4136,70 @@ export type Metafield = Node & { namespace: Scalars['String'] /** The parent object that the metafield belongs to. */ parentResource: MetafieldParentResource + /** Returns a reference object if the metafield definition's type is a resource reference. */ + reference?: Maybe + /** + * The type name of the metafield. + * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). + * + */ + type: Scalars['String'] /** The date and time when the storefront metafield was updated. */ updatedAt: Scalars['DateTime'] /** The value of a metafield. */ value: Scalars['String'] - /** Represents the metafield value type. */ - valueType: MetafieldValueType } -/** An auto-generated type for paginating through multiple Metafields. */ -export type MetafieldConnection = { - __typename?: 'MetafieldConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Metafield and a cursor during pagination. */ -export type MetafieldEdge = { - __typename?: 'MetafieldEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of MetafieldEdge. */ - node: Metafield +/** + * A filter used to view a subset of products in a collection matching a specific metafield value. + * + * Only the following metafield types are currently supported: + * - `number_integer` + * - `number_decimal` + * - `single_line_text_field` + * - `boolean` as of 2022-04. + * + */ +export type MetafieldFilter = { + /** The key of the metafield to filter on. */ + key: Scalars['String'] + /** The namespace of the metafield to filter on. */ + namespace: Scalars['String'] + /** The value of the metafield. */ + value: Scalars['String'] } /** A resource that the metafield belongs to. */ -export type MetafieldParentResource = Product | ProductVariant +export type MetafieldParentResource = + | Article + | Blog + | Collection + | Customer + | Order + | Page + | Product + | ProductVariant + | Shop -/** Metafield value types. */ -export enum MetafieldValueType { - /** A string metafield. */ - String = 'STRING', - /** An integer metafield. */ - Integer = 'INTEGER', - /** A json string metafield. */ - JsonString = 'JSON_STRING', -} +/** + * Returns the resource which is being referred to by a metafield. + * + */ +export type MetafieldReference = + | GenericFile + | MediaImage + | Page + | Product + | ProductVariant + | Video /** Represents a Shopify hosted 3D model. */ -export type Model3d = Node & - Media & { +export type Model3d = Media & + Node & { __typename?: 'Model3d' /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The media content type. */ mediaContentType: MediaContentType @@ -3048,25 +4233,6 @@ export type MoneyInput = { /** * A monetary value with currency. * - * To format currencies, combine this type's amount and currencyCode fields with your client's locale. - * - * For example, in JavaScript you could use Intl.NumberFormat: - * - * ```js - * new Intl.NumberFormat(locale, { - * style: 'currency', - * currency: currencyCode - * }).format(amount); - * ``` - * - * Other formatting libraries include: - * - * * iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter) - * * Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html) - * * PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php) - * - * For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations - * (such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)). */ export type MoneyV2 = { __typename?: 'MoneyV2' @@ -3076,97 +4242,51 @@ export type MoneyV2 = { currencyCode: CurrencyCode } -/** An auto-generated type for paginating through multiple MoneyV2s. */ -export type MoneyV2Connection = { - __typename?: 'MoneyV2Connection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one MoneyV2 and a cursor during pagination. */ -export type MoneyV2Edge = { - __typename?: 'MoneyV2Edge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of MoneyV2Edge. */ - node: MoneyV2 -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type Mutation = { __typename?: 'Mutation' + /** Updates the attributes on a cart. */ + cartAttributesUpdate?: Maybe /** - * Updates the attributes of a checkout. - * @deprecated Use `checkoutAttributesUpdateV2` instead + * Updates customer information associated with a cart. + * Buyer identity is used to determine + * [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout) + * and should match the customer's shipping address. + * */ - checkoutAttributesUpdate?: Maybe - /** Updates the attributes of a checkout. */ + cartBuyerIdentityUpdate?: Maybe + /** Creates a new cart. */ + cartCreate?: Maybe + /** Updates the discount codes applied to the cart. */ + cartDiscountCodesUpdate?: Maybe + /** Adds a merchandise line to the cart. */ + cartLinesAdd?: Maybe + /** Removes one or more merchandise lines from the cart. */ + cartLinesRemove?: Maybe + /** Updates one or more merchandise lines on a cart. */ + cartLinesUpdate?: Maybe + /** Updates the note on the cart. */ + cartNoteUpdate?: Maybe + /** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */ checkoutAttributesUpdateV2?: Maybe /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ checkoutCompleteFree?: Maybe - /** - * Completes a checkout using a credit card token from Shopify's Vault. - * @deprecated Use `checkoutCompleteWithCreditCardV2` instead - */ - checkoutCompleteWithCreditCard?: Maybe - /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://help.shopify.com/api/guides/sales-channel-sdk/getting-started#request-payment-processing). */ + /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). */ checkoutCompleteWithCreditCardV2?: Maybe - /** - * Completes a checkout with a tokenized payment. - * @deprecated Use `checkoutCompleteWithTokenizedPaymentV2` instead - */ - checkoutCompleteWithTokenizedPayment?: Maybe - /** - * Completes a checkout with a tokenized payment. - * @deprecated Use `checkoutCompleteWithTokenizedPaymentV3` instead - */ - checkoutCompleteWithTokenizedPaymentV2?: Maybe /** Completes a checkout with a tokenized payment. */ checkoutCompleteWithTokenizedPaymentV3?: Maybe /** Creates a new checkout. */ checkoutCreate?: Maybe - /** - * Associates a customer to the checkout. - * @deprecated Use `checkoutCustomerAssociateV2` instead - */ - checkoutCustomerAssociate?: Maybe /** Associates a customer to the checkout. */ checkoutCustomerAssociateV2?: Maybe - /** - * Disassociates the current checkout customer from the checkout. - * @deprecated Use `checkoutCustomerDisassociateV2` instead - */ - checkoutCustomerDisassociate?: Maybe /** Disassociates the current checkout customer from the checkout. */ checkoutCustomerDisassociateV2?: Maybe - /** - * Applies a discount to an existing checkout using a discount code. - * @deprecated Use `checkoutDiscountCodeApplyV2` instead - */ - checkoutDiscountCodeApply?: Maybe /** Applies a discount to an existing checkout using a discount code. */ checkoutDiscountCodeApplyV2?: Maybe - /** Removes the applied discount from an existing checkout. */ + /** Removes the applied discounts from an existing checkout. */ checkoutDiscountCodeRemove?: Maybe - /** - * Updates the email on an existing checkout. - * @deprecated Use `checkoutEmailUpdateV2` instead - */ - checkoutEmailUpdate?: Maybe /** Updates the email on an existing checkout. */ checkoutEmailUpdateV2?: Maybe - /** - * Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards. - * @deprecated Use `checkoutGiftCardsAppend` instead - */ - checkoutGiftCardApply?: Maybe - /** - * Removes an applied gift card from the checkout. - * @deprecated Use `checkoutGiftCardRemoveV2` instead - */ - checkoutGiftCardRemove?: Maybe /** Removes an applied gift card from the checkout. */ checkoutGiftCardRemoveV2?: Maybe /** Appends gift cards to an existing checkout. */ @@ -3179,11 +4299,6 @@ export type Mutation = { checkoutLineItemsReplace?: Maybe /** Updates line items on a checkout. */ checkoutLineItemsUpdate?: Maybe - /** - * Updates the shipping address of an existing checkout. - * @deprecated Use `checkoutShippingAddressUpdateV2` instead - */ - checkoutShippingAddressUpdate?: Maybe /** Updates the shipping address of an existing checkout. */ checkoutShippingAddressUpdateV2?: Maybe /** Updates the shipping lines on an existing checkout. */ @@ -3191,12 +4306,15 @@ export type Mutation = { /** * Creates a customer access token. * The customer access token is required to modify the customer object in any way. + * */ customerAccessTokenCreate?: Maybe /** - * Creates a customer access token using a multipass token instead of email and password. - * A customer record is created if customer does not exist. If a customer record already - * exists but the record is disabled, then it's enabled. + * Creates a customer access token using a + * [multipass token](https://shopify.dev/api/multipass) instead of email and + * password. A customer record is created if the customer doesn't exist. If a customer + * record already exists but the record is disabled, then the customer record is enabled. + * */ customerAccessTokenCreateWithMultipass?: Maybe /** Permanently destroys a customer access token. */ @@ -3206,6 +4324,7 @@ export type Mutation = { * * Access token renewal must happen *before* a token expires. * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. + * */ customerAccessTokenRenew?: Maybe /** Activates a customer. */ @@ -3222,20 +4341,70 @@ export type Mutation = { customerCreate?: Maybe /** Updates the default address of an existing customer. */ customerDefaultAddressUpdate?: Maybe - /** Sends a reset password email to the customer, as the first step in the reset password process. */ + /** + * "Sends a reset password email to the customer. The reset password email contains a reset password URL and token that you can pass to the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the customer password." + * + */ customerRecover?: Maybe - /** Resets a customer’s password with a token received from `CustomerRecover`. */ + /** + * "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * + */ customerReset?: Maybe - /** Resets a customer’s password with the reset password url received from `CustomerRecover`. */ + /** + * "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * + */ customerResetByUrl?: Maybe /** Updates an existing customer. */ customerUpdate?: Maybe } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutAttributesUpdateArgs = { - checkoutId: Scalars['ID'] - input: CheckoutAttributesUpdateInput +export type MutationCartAttributesUpdateArgs = { + attributes: Array + cartId: Scalars['ID'] +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartBuyerIdentityUpdateArgs = { + buyerIdentity: CartBuyerIdentityInput + cartId: Scalars['ID'] +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartCreateArgs = { + input?: InputMaybe +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartDiscountCodesUpdateArgs = { + cartId: Scalars['ID'] + discountCodes?: InputMaybe> +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesAddArgs = { + cartId: Scalars['ID'] + lines: Array +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesRemoveArgs = { + cartId: Scalars['ID'] + lineIds: Array +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesUpdateArgs = { + cartId: Scalars['ID'] + lines: Array +} + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartNoteUpdateArgs = { + cartId: Scalars['ID'] + note?: InputMaybe } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3249,30 +4418,12 @@ export type MutationCheckoutCompleteFreeArgs = { checkoutId: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithCreditCardArgs = { - checkoutId: Scalars['ID'] - payment: CreditCardPaymentInput -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithCreditCardV2Args = { checkoutId: Scalars['ID'] payment: CreditCardPaymentInputV2 } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithTokenizedPaymentArgs = { - checkoutId: Scalars['ID'] - payment: TokenizedPaymentInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithTokenizedPaymentV2Args = { - checkoutId: Scalars['ID'] - payment: TokenizedPaymentInputV2 -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { checkoutId: Scalars['ID'] @@ -3282,12 +4433,7 @@ export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCreateArgs = { input: CheckoutCreateInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerAssociateArgs = { - checkoutId: Scalars['ID'] - customerAccessToken: Scalars['String'] + queueToken?: InputMaybe } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3296,26 +4442,15 @@ export type MutationCheckoutCustomerAssociateV2Args = { customerAccessToken: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerDisassociateArgs = { - checkoutId: Scalars['ID'] -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerDisassociateV2Args = { checkoutId: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutDiscountCodeApplyArgs = { - discountCode: Scalars['String'] - checkoutId: Scalars['ID'] -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeApplyV2Args = { - discountCode: Scalars['String'] checkoutId: Scalars['ID'] + discountCode: Scalars['String'] } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3323,30 +4458,12 @@ export type MutationCheckoutDiscountCodeRemoveArgs = { checkoutId: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutEmailUpdateArgs = { - checkoutId: Scalars['ID'] - email: Scalars['String'] -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutEmailUpdateV2Args = { checkoutId: Scalars['ID'] email: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardApplyArgs = { - giftCardCode: Scalars['String'] - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardRemoveArgs = { - appliedGiftCardId: Scalars['ID'] - checkoutId: Scalars['ID'] -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardRemoveV2Args = { appliedGiftCardId: Scalars['ID'] @@ -3355,14 +4472,14 @@ export type MutationCheckoutGiftCardRemoveV2Args = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardsAppendArgs = { - giftCardCodes: Array checkoutId: Scalars['ID'] + giftCardCodes: Array } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsAddArgs = { - lineItems: Array checkoutId: Scalars['ID'] + lineItems: Array } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3373,8 +4490,8 @@ export type MutationCheckoutLineItemsRemoveArgs = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsReplaceArgs = { - lineItems: Array checkoutId: Scalars['ID'] + lineItems: Array } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3383,16 +4500,10 @@ export type MutationCheckoutLineItemsUpdateArgs = { lineItems: Array } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutShippingAddressUpdateArgs = { - shippingAddress: MailingAddressInput - checkoutId: Scalars['ID'] -} - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingAddressUpdateV2Args = { - shippingAddress: MailingAddressInput checkoutId: Scalars['ID'] + shippingAddress: MailingAddressInput } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3435,21 +4546,21 @@ export type MutationCustomerActivateByUrlArgs = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressCreateArgs = { - customerAccessToken: Scalars['String'] address: MailingAddressInput + customerAccessToken: Scalars['String'] } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressDeleteArgs = { - id: Scalars['ID'] customerAccessToken: Scalars['String'] + id: Scalars['ID'] } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressUpdateArgs = { + address: MailingAddressInput customerAccessToken: Scalars['String'] id: Scalars['ID'] - address: MailingAddressInput } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3459,8 +4570,8 @@ export type MutationCustomerCreateArgs = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerDefaultAddressUpdateArgs = { - customerAccessToken: Scalars['String'] addressId: Scalars['ID'] + customerAccessToken: Scalars['String'] } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ @@ -3476,164 +4587,212 @@ export type MutationCustomerResetArgs = { /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetByUrlArgs = { - resetUrl: Scalars['URL'] password: Scalars['String'] + resetUrl: Scalars['URL'] } /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerUpdateArgs = { - customerAccessToken: Scalars['String'] customer: CustomerUpdateInput + customerAccessToken: Scalars['String'] } -/** An object with an ID to support global identification. */ +/** + * An object with an ID field to support global identification, in accordance with the + * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). + * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) + * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * + */ export type Node = { - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] } +/** Represents a resource that can be published to the Online Store sales channel. */ +export type OnlineStorePublishable = { + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe +} + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ -export type Order = Node & { - __typename?: 'Order' - /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ - cancelReason?: Maybe - /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ - canceledAt?: Maybe - /** The code of the currency used for the payment. */ - currencyCode: CurrencyCode - /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. */ - currentSubtotalPrice: MoneyV2 - /** The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. */ - currentTotalPrice: MoneyV2 - /** The total of all taxes applied to the order, excluding taxes for returned line items. */ - currentTotalTax: MoneyV2 - /** The locale code in which this specific order happened. */ - customerLocale?: Maybe - /** The unique URL that the customer can use to access the order. */ - customerUrl?: Maybe - /** Discounts that have been applied on the order. */ - discountApplications: DiscountApplicationConnection - /** Whether the order has had any edits applied or not. */ - edited: Scalars['Boolean'] - /** The customer's email address. */ - email?: Maybe - /** The financial status of the order. */ - financialStatus?: Maybe - /** The fulfillment status for the order. */ - fulfillmentStatus: OrderFulfillmentStatus - /** Globally unique identifier. */ - id: Scalars['ID'] - /** List of the order’s line items. */ - lineItems: OrderLineItemConnection - /** - * Unique identifier for the order that appears on the order. - * For example, _#1000_ or _Store1001. - */ - name: Scalars['String'] - /** A unique numeric identifier for the order for use by shop owner and customer. */ - orderNumber: Scalars['Int'] - /** The total price of the order before any applied edits. */ - originalTotalPrice: MoneyV2 - /** The customer's phone number for receiving SMS notifications. */ - phone?: Maybe - /** - * The date and time when the order was imported. - * This value can be set to dates in the past when importing from other systems. - * If no value is provided, it will be auto-generated based on current date and time. - */ - processedAt: Scalars['DateTime'] - /** The address to where the order will be shipped. */ - shippingAddress?: Maybe - /** The discounts that have been allocated onto the shipping line by discount applications. */ - shippingDiscountAllocations: Array - /** The unique URL for the order's status page. */ - statusUrl: Scalars['URL'] - /** - * Price of the order before shipping and taxes. - * @deprecated Use `subtotalPriceV2` instead - */ - subtotalPrice?: Maybe - /** Price of the order before duties, shipping and taxes. */ - subtotalPriceV2?: Maybe - /** List of the order’s successful fulfillments. */ - successfulFulfillments?: Maybe> - /** - * The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). - * @deprecated Use `totalPriceV2` instead - */ - totalPrice: Scalars['Money'] - /** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */ - totalPriceV2: MoneyV2 - /** - * The total amount that has been refunded. - * @deprecated Use `totalRefundedV2` instead - */ - totalRefunded: Scalars['Money'] - /** The total amount that has been refunded. */ - totalRefundedV2: MoneyV2 - /** - * The total cost of shipping. - * @deprecated Use `totalShippingPriceV2` instead - */ - totalShippingPrice: Scalars['Money'] - /** The total cost of shipping. */ - totalShippingPriceV2: MoneyV2 - /** - * The total cost of taxes. - * @deprecated Use `totalTaxV2` instead - */ - totalTax?: Maybe - /** The total cost of taxes. */ - totalTaxV2?: Maybe -} +export type Order = HasMetafields & + Node & { + __typename?: 'Order' + /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ + cancelReason?: Maybe + /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ + canceledAt?: Maybe + /** The code of the currency used for the payment. */ + currencyCode: CurrencyCode + /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. */ + currentSubtotalPrice: MoneyV2 + /** The total cost of duties for the order, including refunds. */ + currentTotalDuties?: Maybe + /** The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. */ + currentTotalPrice: MoneyV2 + /** The total of all taxes applied to the order, excluding taxes for returned line items. */ + currentTotalTax: MoneyV2 + /** The locale code in which this specific order happened. */ + customerLocale?: Maybe + /** The unique URL that the customer can use to access the order. */ + customerUrl?: Maybe + /** Discounts that have been applied on the order. */ + discountApplications: DiscountApplicationConnection + /** Whether the order has had any edits applied or not. */ + edited: Scalars['Boolean'] + /** The customer's email address. */ + email?: Maybe + /** The financial status of the order. */ + financialStatus?: Maybe + /** The fulfillment status for the order. */ + fulfillmentStatus: OrderFulfillmentStatus + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** List of the order’s line items. */ + lineItems: OrderLineItemConnection + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** + * Unique identifier for the order that appears on the order. + * For example, _#1000_ or _Store1001. + * + */ + name: Scalars['String'] + /** A unique numeric identifier for the order for use by shop owner and customer. */ + orderNumber: Scalars['Int'] + /** The total cost of duties charged at checkout. */ + originalTotalDuties?: Maybe + /** The total price of the order before any applied edits. */ + originalTotalPrice: MoneyV2 + /** The customer's phone number for receiving SMS notifications. */ + phone?: Maybe + /** + * The date and time when the order was imported. + * This value can be set to dates in the past when importing from other systems. + * If no value is provided, it will be auto-generated based on current date and time. + * + */ + processedAt: Scalars['DateTime'] + /** The address to where the order will be shipped. */ + shippingAddress?: Maybe + /** + * The discounts that have been allocated onto the shipping line by discount applications. + * + */ + shippingDiscountAllocations: Array + /** The unique URL for the order's status page. */ + statusUrl: Scalars['URL'] + /** + * Price of the order before shipping and taxes. + * @deprecated Use `subtotalPriceV2` instead. + */ + subtotalPrice?: Maybe + /** Price of the order before duties, shipping and taxes. */ + subtotalPriceV2?: Maybe + /** List of the order’s successful fulfillments. */ + successfulFulfillments?: Maybe> + /** + * The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). + * @deprecated Use `totalPriceV2` instead. + */ + totalPrice: Scalars['Money'] + /** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */ + totalPriceV2: MoneyV2 + /** + * The total amount that has been refunded. + * @deprecated Use `totalRefundedV2` instead. + */ + totalRefunded: Scalars['Money'] + /** The total amount that has been refunded. */ + totalRefundedV2: MoneyV2 + /** + * The total cost of shipping. + * @deprecated Use `totalShippingPriceV2` instead. + */ + totalShippingPrice: Scalars['Money'] + /** The total cost of shipping. */ + totalShippingPriceV2: MoneyV2 + /** + * The total cost of taxes. + * @deprecated Use `totalTaxV2` instead. + */ + totalTax?: Maybe + /** The total cost of taxes. */ + totalTaxV2?: Maybe + } /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderDiscountApplicationsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] +} + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderMetafieldsArgs = { + identifiers: Array } /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderSuccessfulFulfillmentsArgs = { - first?: Maybe + first?: InputMaybe } /** Represents the reason for the order's cancellation. */ export enum OrderCancelReason { /** The customer wanted to cancel the order. */ Customer = 'CUSTOMER', + /** Payment was declined. */ + Declined = 'DECLINED', /** The order was fraudulent. */ Fraud = 'FRAUD', /** There was insufficient inventory. */ Inventory = 'INVENTORY', - /** Payment was declined. */ - Declined = 'DECLINED', /** The order was canceled for an unlisted reason. */ Other = 'OTHER', } -/** An auto-generated type for paginating through multiple Orders. */ +/** + * An auto-generated type for paginating through multiple Orders. + * + */ export type OrderConnection = { __typename?: 'OrderConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in OrderEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Order and a cursor during pagination. */ +/** + * An auto-generated type which holds one Order and a cursor during pagination. + * + */ export type OrderEdge = { __typename?: 'OrderEdge' /** A cursor for use in pagination. */ @@ -3644,40 +4803,42 @@ export type OrderEdge = { /** Represents the order's current financial status. */ export enum OrderFinancialStatus { - /** Displayed as **Pending**. */ - Pending = 'PENDING', /** Displayed as **Authorized**. */ Authorized = 'AUTHORIZED', + /** Displayed as **Paid**. */ + Paid = 'PAID', /** Displayed as **Partially paid**. */ PartiallyPaid = 'PARTIALLY_PAID', /** Displayed as **Partially refunded**. */ PartiallyRefunded = 'PARTIALLY_REFUNDED', - /** Displayed as **Voided**. */ - Voided = 'VOIDED', - /** Displayed as **Paid**. */ - Paid = 'PAID', + /** Displayed as **Pending**. */ + Pending = 'PENDING', /** Displayed as **Refunded**. */ Refunded = 'REFUNDED', + /** Displayed as **Voided**. */ + Voided = 'VOIDED', } -/** Represents the order's current fulfillment status. */ +/** Represents the order's aggregated fulfillment status for display purposes. */ export enum OrderFulfillmentStatus { - /** Displayed as **Unfulfilled**. */ - Unfulfilled = 'UNFULFILLED', - /** Displayed as **Partially fulfilled**. */ - PartiallyFulfilled = 'PARTIALLY_FULFILLED', - /** Displayed as **Fulfilled**. */ + /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ Fulfilled = 'FULFILLED', - /** Displayed as **Restocked**. */ - Restocked = 'RESTOCKED', - /** Displayed as **Pending fulfillment**. */ - PendingFulfillment = 'PENDING_FULFILLMENT', - /** Displayed as **Open**. */ - Open = 'OPEN', - /** Displayed as **In progress**. */ + /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ InProgress = 'IN_PROGRESS', - /** Displayed as **Scheduled**. */ + /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ + OnHold = 'ON_HOLD', + /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ + Open = 'OPEN', + /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ + PartiallyFulfilled = 'PARTIALLY_FULFILLED', + /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ + PendingFulfillment = 'PENDING_FULFILLMENT', + /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ + Restocked = 'RESTOCKED', + /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ Scheduled = 'SCHEDULED', + /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ + Unfulfilled = 'UNFULFILLED', } /** Represents a single line in an order. There is one line item for each distinct product variant. */ @@ -3701,16 +4862,24 @@ export type OrderLineItem = { variant?: Maybe } -/** An auto-generated type for paginating through multiple OrderLineItems. */ +/** + * An auto-generated type for paginating through multiple OrderLineItems. + * + */ export type OrderLineItemConnection = { __typename?: 'OrderLineItemConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in OrderLineItemEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one OrderLineItem and a cursor during pagination. */ +/** + * An auto-generated type which holds one OrderLineItem and a cursor during pagination. + * + */ export type OrderLineItemEdge = { __typename?: 'OrderLineItemEdge' /** A cursor for use in pagination. */ @@ -3721,53 +4890,81 @@ export type OrderLineItemEdge = { /** The set of valid sort keys for the Order query. */ export enum OrderSortKeys { - /** Sort by the `processed_at` value. */ - ProcessedAt = 'PROCESSED_AT', - /** Sort by the `total_price` value. */ - TotalPrice = 'TOTAL_PRICE', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `processed_at` value. */ + ProcessedAt = 'PROCESSED_AT', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `total_price` value. */ + TotalPrice = 'TOTAL_PRICE', } /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ -export type Page = Node & { - __typename?: 'Page' - /** The description of the page, complete with HTML formatting. */ - body: Scalars['HTML'] - /** Summary of the page body. */ - bodySummary: Scalars['String'] - /** The timestamp of the page creation. */ - createdAt: Scalars['DateTime'] - /** A human-friendly unique string for the page automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The page's SEO information. */ - seo?: Maybe - /** The title of the page. */ - title: Scalars['String'] - /** The timestamp of the latest page update. */ - updatedAt: Scalars['DateTime'] - /** The url pointing to the page accessible from the web. */ - url: Scalars['URL'] +export type Page = HasMetafields & + Node & + OnlineStorePublishable & { + __typename?: 'Page' + /** The description of the page, complete with HTML formatting. */ + body: Scalars['HTML'] + /** Summary of the page body. */ + bodySummary: Scalars['String'] + /** The timestamp of the page creation. */ + createdAt: Scalars['DateTime'] + /** A human-friendly unique string for the page automatically generated from its title. */ + handle: Scalars['String'] + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe + /** The page's SEO information. */ + seo?: Maybe + /** The title of the page. */ + title: Scalars['String'] + /** The timestamp of the latest page update. */ + updatedAt: Scalars['DateTime'] + } + +/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ +export type PageMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] } -/** An auto-generated type for paginating through multiple Pages. */ +/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ +export type PageMetafieldsArgs = { + identifiers: Array +} + +/** + * An auto-generated type for paginating through multiple Pages. + * + */ export type PageConnection = { __typename?: 'PageConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in PageEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Page and a cursor during pagination. */ +/** + * An auto-generated type which holds one Page and a cursor during pagination. + * + */ export type PageEdge = { __typename?: 'PageEdge' /** A cursor for use in pagination. */ @@ -3776,29 +4973,37 @@ export type PageEdge = { node: Page } -/** Information about pagination in a connection. */ +/** + * Returns information about pagination in a connection, in accordance with the + * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). + * + */ export type PageInfo = { __typename?: 'PageInfo' - /** Indicates if there are more pages to fetch. */ + /** The cursor corresponding to the last node in edges. */ + endCursor?: Maybe + /** Whether there are more pages to fetch following the current page. */ hasNextPage: Scalars['Boolean'] - /** Indicates if there are any pages prior to the current page. */ + /** Whether there are any pages prior to the current page. */ hasPreviousPage: Scalars['Boolean'] + /** The cursor corresponding to the first node in edges. */ + startCursor?: Maybe } /** The set of valid sort keys for the Page query. */ export enum PageSortKeys { + /** Sort by the `id` value. */ + Id = 'ID', + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + Relevance = 'RELEVANCE', /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', } /** A payment applied to a checkout. */ @@ -3806,7 +5011,7 @@ export type Payment = Node & { __typename?: 'Payment' /** * The amount of the payment. - * @deprecated Use `amountV2` instead + * @deprecated Use `amountV2` instead. */ amount: Scalars['Money'] /** The amount of the payment. */ @@ -3819,17 +5024,18 @@ export type Payment = Node & { creditCard?: Maybe /** A message describing a processing error during asynchronous processing. */ errorMessage?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** * A client-side generated token to identify a payment and perform idempotent operations. * For more information, refer to - * [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). + * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). + * */ idempotencyKey?: Maybe /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ nextActionUrl?: Maybe - /** Whether or not the payment is still processing asynchronously. */ + /** Whether the payment is still processing asynchronously. */ ready: Scalars['Boolean'] /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ test: Scalars['Boolean'] @@ -3860,12 +5066,22 @@ export type PaymentSettings = { export enum PaymentTokenType { /** Apple Pay token type. */ ApplePay = 'APPLE_PAY', - /** Vault payment token type. */ - Vault = 'VAULT', - /** Shopify Pay token type. */ - ShopifyPay = 'SHOPIFY_PAY', /** Google Pay token type. */ GooglePay = 'GOOGLE_PAY', + /** Shopify Pay token type. */ + ShopifyPay = 'SHOPIFY_PAY', + /** Stripe token type. */ + StripeVaultToken = 'STRIPE_VAULT_TOKEN', + /** Vault payment token type. */ + Vault = 'VAULT', +} + +/** A filter used to view a subset of products in a collection matching a specific price range. */ +export type PriceRangeFilter = { + /** The maximum price in the range. Empty indicates no max price. */ + max?: InputMaybe + /** The minimum price in the range. Defaults to zero. */ + min?: InputMaybe } /** The value of the percentage pricing object. */ @@ -3882,8 +5098,9 @@ export type PricingValue = MoneyV2 | PricingPercentageValue * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ -export type Product = Node & - HasMetafields & { +export type Product = HasMetafields & + Node & + OnlineStorePublishable & { __typename?: 'Product' /** Indicates if at least one product variant is available for sale. */ availableForSale: Scalars['Boolean'] @@ -3897,41 +5114,52 @@ export type Product = Node & description: Scalars['String'] /** The description of the product, complete with HTML formatting. */ descriptionHtml: Scalars['HTML'] + /** + * The featured image for the product. + * + * This field is functionally equivalent to `images(first: 1)`. + * + */ + featuredImage?: Maybe /** * A human-friendly unique string for the Product automatically generated from its title. * They are used by the Liquid templating language to refer to objects. + * */ handle: Scalars['String'] - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** List of images associated with the product. */ images: ImageConnection /** The media associated with the product. */ media: MediaConnection - /** The metafield associated with the resource. */ + /** Returns a metafield found by namespace and key. */ metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection /** - * The online store URL for the product. - * A value of `null` indicates that the product is not published to the Online Store sales channel. + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * */ + metafields: Array> + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ onlineStoreUrl?: Maybe /** List of product options. */ options: Array - /** List of price ranges in the presentment currencies for this shop. */ - presentmentPriceRanges: ProductPriceRangeConnection /** The price range. */ priceRange: ProductPriceRange /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ productType: Scalars['String'] /** The date and time when the product was published to the channel. */ publishedAt: Scalars['DateTime'] + /** Whether the product can only be purchased with a selling plan. */ + requiresSellingPlan: Scalars['Boolean'] + /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ + sellingPlanGroups: SellingPlanGroupConnection /** The product's SEO information. */ seo: Seo /** * A comma separated list of tags that have been added to the product. * Additional access scope required for private apps: unauthenticated_read_product_tags. + * */ tags: Array /** The product’s title. */ @@ -3943,12 +5171,14 @@ export type Product = Node & * A product's `updatedAt` value can change for different reasons. For example, if an order * is placed for a product that has inventory tracking set up, then the inventory adjustment * is counted as an update. + * */ updatedAt: Scalars['DateTime'] /** * Find a product’s variant based on its selected options. * This is useful for converting a user’s selection of product options into a single matching variant. * If there is not a variant for the selected options, `null` will be returned. + * */ variantBySelectedOptions?: Maybe /** List of the product’s variants. */ @@ -3962,11 +5192,11 @@ export type Product = Node & * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** @@ -3974,7 +5204,7 @@ export type ProductCollectionsArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductDescriptionArgs = { - truncateAt?: Maybe + truncateAt?: InputMaybe } /** @@ -3982,16 +5212,12 @@ export type ProductDescriptionArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductImagesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } /** @@ -3999,12 +5225,12 @@ export type ProductImagesArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductMediaArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } /** @@ -4012,8 +5238,8 @@ export type ProductMediaArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductMetafieldArgs = { - namespace: Scalars['String'] key: Scalars['String'] + namespace: Scalars['String'] } /** @@ -4021,12 +5247,7 @@ export type ProductMetafieldArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + identifiers: Array } /** @@ -4034,20 +5255,19 @@ export type ProductMetafieldsArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductOptionsArgs = { - first?: Maybe + first?: InputMaybe } /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ -export type ProductPresentmentPriceRangesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe +export type ProductSellingPlanGroupsArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** @@ -4063,48 +5283,58 @@ export type ProductVariantBySelectedOptionsArgs = { * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). */ export type ProductVariantsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } /** The set of valid sort keys for the ProductCollection query. */ export enum ProductCollectionSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `price` value. */ - Price = 'PRICE', /** Sort by the `best-selling` value. */ BestSelling = 'BEST_SELLING', + /** Sort by the `collection-default` value. */ + CollectionDefault = 'COLLECTION_DEFAULT', /** Sort by the `created` value. */ Created = 'CREATED', /** Sort by the `id` value. */ Id = 'ID', /** Sort by the `manual` value. */ Manual = 'MANUAL', - /** Sort by the `collection-default` value. */ - CollectionDefault = 'COLLECTION_DEFAULT', + /** Sort by the `price` value. */ + Price = 'PRICE', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `title` value. */ + Title = 'TITLE', } -/** An auto-generated type for paginating through multiple Products. */ +/** + * An auto-generated type for paginating through multiple Products. + * + */ export type ProductConnection = { __typename?: 'ProductConnection' /** A list of edges. */ edges: Array + /** A list of available filters. */ + filters: Array + /** A list of the nodes contained in ProductEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one Product and a cursor during pagination. */ +/** + * An auto-generated type which holds one Product and a cursor during pagination. + * + */ export type ProductEdge = { __typename?: 'ProductEdge' /** A cursor for use in pagination. */ @@ -4113,32 +5343,50 @@ export type ProductEdge = { node: Product } +/** A filter used to view a subset of products in a collection. */ +export type ProductFilter = { + /** Filter on if the product is available for sale. */ + available?: InputMaybe + /** A range of prices to filter with-in. */ + price?: InputMaybe + /** A product metafield to filter on. */ + productMetafield?: InputMaybe + /** The product type to filter on. */ + productType?: InputMaybe + /** The product vendor to filter on. */ + productVendor?: InputMaybe + /** A variant metafield to filter on. */ + variantMetafield?: InputMaybe + /** A variant option to filter on. */ + variantOption?: InputMaybe +} + /** The set of valid sort keys for the ProductImage query. */ export enum ProductImageSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', - /** Sort by the `position` value. */ - Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `position` value. */ + Position = 'POSITION', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', } /** The set of valid sort keys for the ProductMedia query. */ export enum ProductMediaSortKeys { - /** Sort by the `position` value. */ - Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `position` value. */ + Position = 'POSITION', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', } @@ -4147,10 +5395,11 @@ export enum ProductMediaSortKeys { * Product property names like "Size", "Color", and "Material" that the customers can select. * Variants are selected based on permutations of these options. * 255 characters limit each. + * */ export type ProductOption = Node & { __typename?: 'ProductOption' - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The product option’s name. */ name: Scalars['String'] @@ -4167,85 +5416,66 @@ export type ProductPriceRange = { minVariantPrice: MoneyV2 } -/** An auto-generated type for paginating through multiple ProductPriceRanges. */ -export type ProductPriceRangeConnection = { - __typename?: 'ProductPriceRangeConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one ProductPriceRange and a cursor during pagination. */ -export type ProductPriceRangeEdge = { - __typename?: 'ProductPriceRangeEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductPriceRangeEdge. */ - node: ProductPriceRange -} - /** The set of valid sort keys for the Product query. */ export enum ProductSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `product_type` value. */ - ProductType = 'PRODUCT_TYPE', - /** Sort by the `vendor` value. */ - Vendor = 'VENDOR', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `created_at` value. */ - CreatedAt = 'CREATED_AT', /** Sort by the `best_selling` value. */ BestSelling = 'BEST_SELLING', - /** Sort by the `price` value. */ - Price = 'PRICE', + /** Sort by the `created_at` value. */ + CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `price` value. */ + Price = 'PRICE', + /** Sort by the `product_type` value. */ + ProductType = 'PRODUCT_TYPE', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `title` value. */ + Title = 'TITLE', + /** Sort by the `updated_at` value. */ + UpdatedAt = 'UPDATED_AT', + /** Sort by the `vendor` value. */ + Vendor = 'VENDOR', } /** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariant = Node & - HasMetafields & { +export type ProductVariant = HasMetafields & + Node & { __typename?: 'ProductVariant' - /** - * Indicates if the product variant is in stock. - * @deprecated Use `availableForSale` instead - */ - available?: Maybe /** Indicates if the product variant is available for sale. */ availableForSale: Scalars['Boolean'] + /** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */ + barcode?: Maybe /** * The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. - * @deprecated Use `compareAtPriceV2` instead + * @deprecated Use `compareAtPriceV2` instead. */ compareAtPrice?: Maybe /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. */ compareAtPriceV2?: Maybe /** Whether a product is out of stock but still available for purchase (used for backorders). */ currentlyNotInStock: Scalars['Boolean'] - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] - /** Image associated with the product variant. This field falls back to the product image if no image is available. */ + /** + * Image associated with the product variant. This field falls back to the product image if no image is available. + * + */ image?: Maybe - /** The metafield associated with the resource. */ + /** Returns a metafield found by namespace and key. */ metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection - /** List of prices and compare-at prices in the presentment currencies for this shop. */ - presentmentPrices: ProductVariantPricePairConnection - /** List of unit prices in the presentment currencies for this shop. */ - presentmentUnitPrices: MoneyV2Connection + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> /** * The product variant’s price. - * @deprecated Use `priceV2` instead + * @deprecated Use `priceV2` instead. */ price: Scalars['Money'] /** The product variant’s price. */ @@ -4258,8 +5488,12 @@ export type ProductVariant = Node & requiresShipping: Scalars['Boolean'] /** List of product options applied to the variant. */ selectedOptions: Array + /** Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. */ + sellingPlanAllocations: SellingPlanAllocationConnection /** The SKU (stock keeping unit) associated with the variant. */ sku?: Maybe + /** The in-store pickup availability of this variant by location. */ + storeAvailability: StoreAvailabilityConnection /** The product variant’s title. */ title: Scalars['String'] /** The unit price value for the variant based on the variant's measurement. */ @@ -4272,60 +5506,53 @@ export type ProductVariant = Node & weightUnit: WeightUnit } -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe -} - /** A product variant represents a different version of a product, such as differing sizes or differing colors. */ export type ProductVariantMetafieldArgs = { - namespace: Scalars['String'] key: Scalars['String'] + namespace: Scalars['String'] } /** A product variant represents a different version of a product, such as differing sizes or differing colors. */ export type ProductVariantMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe + identifiers: Array } /** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantPresentmentPricesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe +export type ProductVariantSellingPlanAllocationsArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantPresentmentUnitPricesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe +export type ProductVariantStoreAvailabilityArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } -/** An auto-generated type for paginating through multiple ProductVariants. */ +/** + * An auto-generated type for paginating through multiple ProductVariants. + * + */ export type ProductVariantConnection = { __typename?: 'ProductVariantConnection' /** A list of edges. */ edges: Array + /** A list of the nodes contained in ProductVariantEdge. */ + nodes: Array /** Information to aid in pagination. */ pageInfo: PageInfo } -/** An auto-generated type which holds one ProductVariant and a cursor during pagination. */ +/** + * An auto-generated type which holds one ProductVariant and a cursor during pagination. + * + */ export type ProductVariantEdge = { __typename?: 'ProductVariantEdge' /** A cursor for use in pagination. */ @@ -4334,49 +5561,22 @@ export type ProductVariantEdge = { node: ProductVariant } -/** The compare-at price and price of a variant sharing a currency. */ -export type ProductVariantPricePair = { - __typename?: 'ProductVariantPricePair' - /** The compare-at price of the variant with associated currency. */ - compareAtPrice?: Maybe - /** The price of the variant with associated currency. */ - price: MoneyV2 -} - -/** An auto-generated type for paginating through multiple ProductVariantPricePairs. */ -export type ProductVariantPricePairConnection = { - __typename?: 'ProductVariantPricePairConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. */ -export type ProductVariantPricePairEdge = { - __typename?: 'ProductVariantPricePairEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductVariantPricePairEdge. */ - node: ProductVariantPricePair -} - /** The set of valid sort keys for the ProductVariant query. */ export enum ProductVariantSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `sku` value. */ - Sku = 'SKU', - /** Sort by the `position` value. */ - Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', + /** Sort by the `position` value. */ + Position = 'POSITION', /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * */ Relevance = 'RELEVANCE', + /** Sort by the `sku` value. */ + Sku = 'SKU', + /** Sort by the `title` value. */ + Title = 'TITLE', } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ @@ -4384,35 +5584,70 @@ export type QueryRoot = { __typename?: 'QueryRoot' /** List of the shop's articles. */ articles: ArticleConnection - /** Find a blog by its handle. */ + /** Fetch a specific `Blog` by one of its unique attributes. */ + blog?: Maybe + /** + * Find a blog by its handle. + * @deprecated Use `blog` instead. + */ blogByHandle?: Maybe /** List of the shop's blogs. */ blogs: BlogConnection - /** Find a collection by its handle. */ + /** Retrieve a cart by its ID. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). */ + cart?: Maybe + /** Fetch a specific `Collection` by one of its unique attributes. */ + collection?: Maybe + /** + * Find a collection by its handle. + * @deprecated Use `collection` instead. + */ collectionByHandle?: Maybe /** List of the shop’s collections. */ collections: CollectionConnection /** Find a customer by its access token. */ customer?: Maybe + /** Returns the localized experiences configured for the shop. */ + localization: Localization + /** + * List of the shop's locations that support in-store pickup. + * + * When sorting by distance, you must specify a location via the `near` argument. + * + */ + locations: LocationConnection + /** A storefront menu. */ + menu?: Maybe /** Returns a specific node by ID. */ node?: Maybe /** Returns the list of nodes with the given IDs. */ nodes: Array> - /** Find a page by its handle. */ + /** Fetch a specific `Page` by one of its unique attributes. */ + page?: Maybe + /** + * Find a page by its handle. + * @deprecated Use `page` instead. + */ pageByHandle?: Maybe /** List of the shop's pages. */ pages: PageConnection - /** Find a product by its handle. */ + /** Fetch a specific `Product` by one of its unique attributes. */ + product?: Maybe + /** + * Find a product by its handle. + * @deprecated Use `product` instead. + */ productByHandle?: Maybe /** * Find recommended products related to a given `product_id`. * To learn more about how recommendations are generated, see * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). + * */ productRecommendations?: Maybe> /** * Tags added to products. * Additional access scope required: unauthenticated_read_product_tags. + * */ productTags: StringConnection /** List of product types for the shop's products that are published to your app. */ @@ -4423,17 +5658,25 @@ export type QueryRoot = { publicApiVersions: Array /** The shop associated with the storefront access token. */ shop: Shop + /** A list of redirects for a shop. */ + urlRedirects: UrlRedirectConnection } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootBlogArgs = { + handle?: InputMaybe + id?: InputMaybe } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ @@ -4443,13 +5686,24 @@ export type QueryRootBlogByHandleArgs = { /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCartArgs = { + id: Scalars['ID'] +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionArgs = { + handle?: InputMaybe + id?: InputMaybe } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ @@ -4459,13 +5713,13 @@ export type QueryRootCollectionByHandleArgs = { /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ @@ -4473,6 +5727,22 @@ export type QueryRootCustomerArgs = { customerAccessToken: Scalars['String'] } +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootLocationsArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + near?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMenuArgs = { + handle: Scalars['String'] +} + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodeArgs = { id: Scalars['ID'] @@ -4483,6 +5753,12 @@ export type QueryRootNodesArgs = { ids: Array } +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPageArgs = { + handle?: InputMaybe + id?: InputMaybe +} + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageByHandleArgs = { handle: Scalars['String'] @@ -4490,13 +5766,19 @@ export type QueryRootPageByHandleArgs = { /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPagesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductArgs = { + handle?: InputMaybe + id?: InputMaybe } /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ @@ -4521,13 +5803,22 @@ export type QueryRootProductTypesArgs = { /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + query?: InputMaybe + reverse?: InputMaybe + sortKey?: InputMaybe +} + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectsArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe } /** SEO information. */ @@ -4542,16 +5833,12 @@ export type Seo = { /** * Script discount applications capture the intentions of a discount that * was created by a Shopify Script. + * */ export type ScriptDiscountApplication = DiscountApplication & { __typename?: 'ScriptDiscountApplication' /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod - /** - * The description of the application as defined by the Script. - * @deprecated Use `title` instead - */ - description: Scalars['String'] /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection /** The type of line that the discount is applicable towards. */ @@ -4565,6 +5852,7 @@ export type ScriptDiscountApplication = DiscountApplication & { /** * Properties used by customers to select a product variant. * Products can have multiple options, like different sizes or colors. + * */ export type SelectedOption = { __typename?: 'SelectedOption' @@ -4582,6 +5870,238 @@ export type SelectedOptionInput = { value: Scalars['String'] } +/** Represents how products and variants can be sold and purchased. */ +export type SellingPlan = { + __typename?: 'SellingPlan' + /** The initial payment due for the purchase. */ + checkoutCharge: SellingPlanCheckoutCharge + /** The description of the selling plan. */ + description?: Maybe + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */ + name: Scalars['String'] + /** The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. */ + options: Array + /** The price adjustments that a selling plan makes when a variant is purchased with a selling plan. */ + priceAdjustments: Array + /** Whether purchasing the selling plan will result in multiple deliveries. */ + recurringDeliveries: Scalars['Boolean'] +} + +/** Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. */ +export type SellingPlanAllocation = { + __typename?: 'SellingPlanAllocation' + /** The checkout charge amount due for the purchase. */ + checkoutChargeAmount: MoneyV2 + /** A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it. */ + priceAdjustments: Array + /** The remaining balance charge amount due for the purchase. */ + remainingBalanceChargeAmount: MoneyV2 + /** 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'. */ + sellingPlan: SellingPlan +} + +/** + * An auto-generated type for paginating through multiple SellingPlanAllocations. + * + */ +export type SellingPlanAllocationConnection = { + __typename?: 'SellingPlanAllocationConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in SellingPlanAllocationEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination. + * + */ +export type SellingPlanAllocationEdge = { + __typename?: 'SellingPlanAllocationEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of SellingPlanAllocationEdge. */ + node: SellingPlanAllocation +} + +/** The resulting prices for variants when they're purchased with a specific selling plan. */ +export type SellingPlanAllocationPriceAdjustment = { + __typename?: 'SellingPlanAllocationPriceAdjustment' + /** The price of the variant when it's purchased without a selling plan for the same number of deliveries. For example, if a customer purchases 6 deliveries of $10.00 granola separately, then the price is 6 x $10.00 = $60.00. */ + compareAtPrice: MoneyV2 + /** The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00. */ + perDeliveryPrice: MoneyV2 + /** The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00. */ + price: MoneyV2 + /** The resulting price per unit for the variant associated with the selling plan. If the variant isn't sold by quantity or measurement, then this field returns `null`. */ + unitPrice?: Maybe +} + +/** The initial payment due for the purchase. */ +export type SellingPlanCheckoutCharge = { + __typename?: 'SellingPlanCheckoutCharge' + /** The charge type for the checkout charge. */ + type: SellingPlanCheckoutChargeType + /** The charge value for the checkout charge. */ + value: SellingPlanCheckoutChargeValue +} + +/** The percentage value of the price used for checkout charge. */ +export type SellingPlanCheckoutChargePercentageValue = { + __typename?: 'SellingPlanCheckoutChargePercentageValue' + /** The percentage value of the price used for checkout charge. */ + percentage: Scalars['Float'] +} + +/** The checkout charge when the full amount isn't charged at checkout. */ +export enum SellingPlanCheckoutChargeType { + /** The checkout charge is a percentage of the product or variant price. */ + Percentage = 'PERCENTAGE', + /** The checkout charge is a fixed price amount. */ + Price = 'PRICE', +} + +/** The portion of the price to be charged at checkout. */ +export type SellingPlanCheckoutChargeValue = + | MoneyV2 + | SellingPlanCheckoutChargePercentageValue + +/** + * An auto-generated type for paginating through multiple SellingPlans. + * + */ +export type SellingPlanConnection = { + __typename?: 'SellingPlanConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in SellingPlanEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one SellingPlan and a cursor during pagination. + * + */ +export type SellingPlanEdge = { + __typename?: 'SellingPlanEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of SellingPlanEdge. */ + node: SellingPlan +} + +/** A fixed amount that's deducted from the original variant price. For example, $10.00 off. */ +export type SellingPlanFixedAmountPriceAdjustment = { + __typename?: 'SellingPlanFixedAmountPriceAdjustment' + /** The money value of the price adjustment. */ + adjustmentAmount: MoneyV2 +} + +/** A fixed price adjustment for a variant that's purchased with a selling plan. */ +export type SellingPlanFixedPriceAdjustment = { + __typename?: 'SellingPlanFixedPriceAdjustment' + /** A new price of the variant when it's purchased with the selling plan. */ + price: MoneyV2 +} + +/** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ +export type SellingPlanGroup = { + __typename?: 'SellingPlanGroup' + /** A display friendly name for the app that created the selling plan group. */ + appName?: Maybe + /** The name of the selling plan group. */ + name: Scalars['String'] + /** Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. */ + options: Array + /** 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'. */ + sellingPlans: SellingPlanConnection +} + +/** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ +export type SellingPlanGroupSellingPlansArgs = { + after?: InputMaybe + before?: InputMaybe + first?: InputMaybe + last?: InputMaybe + reverse?: InputMaybe +} + +/** + * An auto-generated type for paginating through multiple SellingPlanGroups. + * + */ +export type SellingPlanGroupConnection = { + __typename?: 'SellingPlanGroupConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in SellingPlanGroupEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. + * + */ +export type SellingPlanGroupEdge = { + __typename?: 'SellingPlanGroupEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of SellingPlanGroupEdge. */ + node: SellingPlanGroup +} + +/** + * Represents an option on a selling plan group that's available in the drop-down list in the storefront. + * + * Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. + */ +export type SellingPlanGroupOption = { + __typename?: 'SellingPlanGroupOption' + /** The name of the option. For example, 'Delivery every'. */ + name: Scalars['String'] + /** The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. */ + values: Array +} + +/** An option provided by a Selling Plan. */ +export type SellingPlanOption = { + __typename?: 'SellingPlanOption' + /** The name of the option (ie "Delivery every"). */ + name?: Maybe + /** The value of the option (ie "Month"). */ + value?: Maybe +} + +/** A percentage amount that's deducted from the original variant price. For example, 10% off. */ +export type SellingPlanPercentagePriceAdjustment = { + __typename?: 'SellingPlanPercentagePriceAdjustment' + /** The percentage value of the price adjustment. */ + adjustmentPercentage: Scalars['Int'] +} + +/** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. */ +export type SellingPlanPriceAdjustment = { + __typename?: 'SellingPlanPriceAdjustment' + /** The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. */ + adjustmentValue: SellingPlanPriceAdjustmentValue + /** The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. */ + orderCount?: Maybe +} + +/** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. */ +export type SellingPlanPriceAdjustmentValue = + | SellingPlanFixedAmountPriceAdjustment + | SellingPlanFixedPriceAdjustment + | SellingPlanPercentagePriceAdjustment + /** A shipping rate to be applied to a checkout. */ export type ShippingRate = { __typename?: 'ShippingRate' @@ -4589,7 +6109,7 @@ export type ShippingRate = { handle: Scalars['String'] /** * Price of this shipping rate. - * @deprecated Use `priceV2` instead + * @deprecated Use `priceV2` instead. */ price: Scalars['Money'] /** Price of this shipping rate. */ @@ -4599,143 +6119,51 @@ export type ShippingRate = { } /** Shop represents a collection of the general settings and information about the shop. */ -export type Shop = { - __typename?: 'Shop' - /** - * List of the shop' articles. - * @deprecated Use `QueryRoot.articles` instead. - */ - articles: ArticleConnection - /** - * List of the shop' blogs. - * @deprecated Use `QueryRoot.blogs` instead. - */ - blogs: BlogConnection - /** - * Find a collection by its handle. - * @deprecated Use `QueryRoot.collectionByHandle` instead. - */ - collectionByHandle?: Maybe - /** - * List of the shop’s collections. - * @deprecated Use `QueryRoot.collections` instead. - */ - collections: CollectionConnection - /** - * The three-letter code for the currency that the shop accepts. - * @deprecated Use `paymentSettings` instead - */ - currencyCode: CurrencyCode - /** A description of the shop. */ - description?: Maybe - /** A string representing the way currency is formatted when the currency isn’t specified. */ - moneyFormat: Scalars['String'] - /** The shop’s name. */ - name: Scalars['String'] - /** Settings related to payments. */ - paymentSettings: PaymentSettings - /** The shop’s primary domain. */ - primaryDomain: Domain - /** The shop’s privacy policy. */ - privacyPolicy?: Maybe - /** - * Find a product by its handle. - * @deprecated Use `QueryRoot.productByHandle` instead. - */ - productByHandle?: Maybe - /** - * A list of tags that have been added to products. - * Additional access scope required: unauthenticated_read_product_tags. - * @deprecated Use `QueryRoot.productTags` instead. - */ - productTags: StringConnection - /** - * List of the shop’s product types. - * @deprecated Use `QueryRoot.productTypes` instead. - */ - productTypes: StringConnection - /** - * List of the shop’s products. - * @deprecated Use `QueryRoot.products` instead. - */ - products: ProductConnection - /** The shop’s refund policy. */ - refundPolicy?: Maybe - /** The shop’s shipping policy. */ - shippingPolicy?: Maybe - /** Countries that the shop ships to. */ - shipsToCountries: Array - /** - * The shop’s Shopify Payments account id. - * @deprecated Use `paymentSettings` instead - */ - shopifyPaymentsAccountId?: Maybe - /** The shop’s terms of service. */ - termsOfService?: Maybe +export type Shop = HasMetafields & + Node & { + __typename?: 'Shop' + /** A description of the shop. */ + description?: Maybe + /** A globally-unique identifier. */ + id: Scalars['ID'] + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe + /** + * The metafields associated with the resource matching the supplied list of namespaces and keys. + * + */ + metafields: Array> + /** A string representing the way currency is formatted when the currency isn’t specified. */ + moneyFormat: Scalars['String'] + /** The shop’s name. */ + name: Scalars['String'] + /** Settings related to payments. */ + paymentSettings: PaymentSettings + /** The primary domain of the shop’s Online Store. */ + primaryDomain: Domain + /** The shop’s privacy policy. */ + privacyPolicy?: Maybe + /** The shop’s refund policy. */ + refundPolicy?: Maybe + /** The shop’s shipping policy. */ + shippingPolicy?: Maybe + /** Countries that the shop ships to. */ + shipsToCountries: Array + /** The shop’s subscription policy. */ + subscriptionPolicy?: Maybe + /** The shop’s terms of service. */ + termsOfService?: Maybe + } + +/** Shop represents a collection of the general settings and information about the shop. */ +export type ShopMetafieldArgs = { + key: Scalars['String'] + namespace: Scalars['String'] } /** Shop represents a collection of the general settings and information about the shop. */ -export type ShopArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopBlogsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopCollectionByHandleArgs = { - handle: Scalars['String'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductByHandleArgs = { - handle: Scalars['String'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductTagsArgs = { - first: Scalars['Int'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductTypesArgs = { - first: Scalars['Int'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe +export type ShopMetafieldsArgs = { + identifiers: Array } /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ @@ -4745,7 +6173,7 @@ export type ShopPolicy = Node & { body: Scalars['String'] /** Policy’s handle. */ handle: Scalars['String'] - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** Policy’s title. */ title: Scalars['String'] @@ -4753,7 +6181,71 @@ export type ShopPolicy = Node & { url: Scalars['URL'] } -/** An auto-generated type for paginating through multiple Strings. */ +/** + * A policy for the store that comes with a default value, such as a subscription policy. + * If the merchant hasn't configured a policy for their store, then the policy will return the default value. + * Otherwise, the policy will return the merchant-configured value. + * + */ +export type ShopPolicyWithDefault = { + __typename?: 'ShopPolicyWithDefault' + /** The text of the policy. Maximum size: 64KB. */ + body: Scalars['String'] + /** The handle of the policy. */ + handle: Scalars['String'] + /** The unique identifier of the policy. A default policy doesn't have an ID. */ + id?: Maybe + /** The title of the policy. */ + title: Scalars['String'] + /** Public URL to the policy. */ + url: Scalars['URL'] +} + +/** + * The availability of a product variant at a particular location. + * Local pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result. + * + */ +export type StoreAvailability = { + __typename?: 'StoreAvailability' + /** Whether the product variant is in-stock at this location. */ + available: Scalars['Boolean'] + /** The location where this product variant is stocked at. */ + location: Location + /** Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). */ + pickUpTime: Scalars['String'] +} + +/** + * An auto-generated type for paginating through multiple StoreAvailabilities. + * + */ +export type StoreAvailabilityConnection = { + __typename?: 'StoreAvailabilityConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in StoreAvailabilityEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one StoreAvailability and a cursor during pagination. + * + */ +export type StoreAvailabilityEdge = { + __typename?: 'StoreAvailabilityEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of StoreAvailabilityEdge. */ + node: StoreAvailability +} + +/** + * An auto-generated type for paginating through a list of Strings. + * + */ export type StringConnection = { __typename?: 'StringConnection' /** A list of edges. */ @@ -4762,7 +6254,10 @@ export type StringConnection = { pageInfo: PageInfo } -/** An auto-generated type which holds one String and a cursor during pagination. */ +/** + * An auto-generated type which holds one String and a cursor during pagination. + * + */ export type StringEdge = { __typename?: 'StringEdge' /** A cursor for use in pagination. */ @@ -4774,62 +6269,21 @@ export type StringEdge = { /** * Specifies the fields required to complete a checkout with * a tokenized payment. - */ -export type TokenizedPaymentInput = { - /** The amount of the payment. */ - amount: Scalars['Money'] - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** The type of payment token. */ - type: Scalars['String'] - /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe -} - -/** - * Specifies the fields required to complete a checkout with - * a tokenized payment. - */ -export type TokenizedPaymentInputV2 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String'] - /** Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe - /** The type of payment token. */ - type: Scalars['String'] -} - -/** - * Specifies the fields required to complete a checkout with - * a tokenized payment. + * */ export type TokenizedPaymentInputV3 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ - idempotencyKey: Scalars['String'] /** The billing address for the payment. */ billingAddress: MailingAddressInput + /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ + idempotencyKey: Scalars['String'] + /** Public Hash Key used for AndroidPay payments only. */ + identifier?: InputMaybe + /** The amount and currency of the payment. */ + paymentAmount: MoneyInput /** A simple string or JSON containing the required payment data for the tokenized payment. */ paymentData: Scalars['String'] /** Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe + test?: InputMaybe /** The type of payment token. */ type: PaymentTokenType } @@ -4839,7 +6293,7 @@ export type Transaction = { __typename?: 'Transaction' /** * The amount of money that the transaction was for. - * @deprecated Use `amountV2` instead + * @deprecated Use `amountV2` instead. */ amount: Scalars['Money'] /** The amount of money that the transaction was for. */ @@ -4848,7 +6302,7 @@ export type Transaction = { kind: TransactionKind /** * The status of the transaction. - * @deprecated Use `statusV2` instead + * @deprecated Use `statusV2` instead. */ status: TransactionStatus /** The status of the transaction. */ @@ -4859,34 +6313,38 @@ export type Transaction = { /** The different kinds of order transactions. */ export enum TransactionKind { - /** An authorization and capture performed together in a single step. */ - Sale = 'SALE', - /** A transfer of the money that was reserved during the authorization stage. */ - Capture = 'CAPTURE', /** * An amount reserved against the cardholder's funding source. * Money does not change hands until the authorization is captured. + * */ Authorization = 'AUTHORIZATION', - /** An authorization for a payment taken with an EMV credit card reader. */ - EmvAuthorization = 'EMV_AUTHORIZATION', + /** A transfer of the money that was reserved during the authorization stage. */ + Capture = 'CAPTURE', /** Money returned to the customer when they have paid too much. */ Change = 'CHANGE', + /** An authorization for a payment taken with an EMV credit card reader. */ + EmvAuthorization = 'EMV_AUTHORIZATION', + /** An authorization and capture performed together in a single step. */ + Sale = 'SALE', } /** Transaction statuses describe the status of a transaction. */ export enum TransactionStatus { + /** There was an error while processing the transaction. */ + Error = 'ERROR', + /** The transaction failed. */ + Failure = 'FAILURE', /** The transaction is pending. */ Pending = 'PENDING', /** The transaction succeeded. */ Success = 'SUCCESS', - /** The transaction failed. */ - Failure = 'FAILURE', - /** There was an error while processing the transaction. */ - Error = 'ERROR', } -/** The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). */ +/** + * The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). + * + */ export type UnitPriceMeasurement = { __typename?: 'UnitPriceMeasurement' /** The type of unit of measurement for the unit price measurement. */ @@ -4903,58 +6361,111 @@ export type UnitPriceMeasurement = { /** The accepted types of unit of measurement. */ export enum UnitPriceMeasurementMeasuredType { + /** Unit of measurements representing areas. */ + Area = 'AREA', + /** Unit of measurements representing lengths. */ + Length = 'LENGTH', /** Unit of measurements representing volumes. */ Volume = 'VOLUME', /** Unit of measurements representing weights. */ Weight = 'WEIGHT', - /** Unit of measurements representing lengths. */ - Length = 'LENGTH', - /** Unit of measurements representing areas. */ - Area = 'AREA', } /** The valid units of measurement for a unit price measurement. */ export enum UnitPriceMeasurementMeasuredUnit { - /** 1000 milliliters equals 1 liter. */ - Ml = 'ML', /** 100 centiliters equals 1 liter. */ Cl = 'CL', - /** Metric system unit of volume. */ - L = 'L', - /** 1 cubic meter equals 1000 liters. */ - M3 = 'M3', - /** 1000 milligrams equals 1 gram. */ - Mg = 'MG', + /** 100 centimeters equals 1 meter. */ + Cm = 'CM', /** Metric system unit of weight. */ G = 'G', /** 1 kilogram equals 1000 grams. */ Kg = 'KG', - /** 1000 millimeters equals 1 meter. */ - Mm = 'MM', - /** 100 centimeters equals 1 meter. */ - Cm = 'CM', + /** Metric system unit of volume. */ + L = 'L', /** Metric system unit of length. */ M = 'M', /** Metric system unit of area. */ M2 = 'M2', + /** 1 cubic meter equals 1000 liters. */ + M3 = 'M3', + /** 1000 milligrams equals 1 gram. */ + Mg = 'MG', + /** 1000 milliliters equals 1 liter. */ + Ml = 'ML', + /** 1000 millimeters equals 1 meter. */ + Mm = 'MM', +} + +/** Systems of weights and measures. */ +export enum UnitSystem { + /** Imperial system of weights and measures. */ + ImperialSystem = 'IMPERIAL_SYSTEM', + /** Metric system of weights and measures. */ + MetricSystem = 'METRIC_SYSTEM', +} + +/** A redirect on the online store. */ +export type UrlRedirect = Node & { + __typename?: 'UrlRedirect' + /** The ID of the URL redirect. */ + id: Scalars['ID'] + /** The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. */ + path: Scalars['String'] + /** The target location where the user will be redirected to. */ + target: Scalars['String'] +} + +/** + * An auto-generated type for paginating through multiple UrlRedirects. + * + */ +export type UrlRedirectConnection = { + __typename?: 'UrlRedirectConnection' + /** A list of edges. */ + edges: Array + /** A list of the nodes contained in UrlRedirectEdge. */ + nodes: Array + /** Information to aid in pagination. */ + pageInfo: PageInfo +} + +/** + * An auto-generated type which holds one UrlRedirect and a cursor during pagination. + * + */ +export type UrlRedirectEdge = { + __typename?: 'UrlRedirectEdge' + /** A cursor for use in pagination. */ + cursor: Scalars['String'] + /** The item at the end of UrlRedirectEdge. */ + node: UrlRedirect } /** Represents an error in the input of a mutation. */ export type UserError = DisplayableError & { __typename?: 'UserError' - /** Path to the input field which caused the error. */ + /** The path to the input field that caused the error. */ field?: Maybe> /** The error message. */ message: Scalars['String'] } +/** A filter used to view a subset of products in a collection matching a specific variant option. */ +export type VariantOptionFilter = { + /** The name of the variant option to filter on. */ + name: Scalars['String'] + /** The value of the variant option to filter on. */ + value: Scalars['String'] +} + /** Represents a Shopify hosted video. */ -export type Video = Node & - Media & { +export type Video = Media & + Node & { __typename?: 'Video' /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe - /** Globally unique identifier. */ + /** A globally-unique identifier. */ id: Scalars['ID'] /** The media content type. */ mediaContentType: MediaContentType @@ -4981,14 +6492,14 @@ export type VideoSource = { /** Units of measurement for weight. */ export enum WeightUnit { - /** 1 kilogram equals 1000 grams. */ - Kilograms = 'KILOGRAMS', /** Metric system unit of mass. */ Grams = 'GRAMS', - /** 1 pound equals 16 ounces. */ - Pounds = 'POUNDS', + /** 1 kilogram equals 1000 grams. */ + Kilograms = 'KILOGRAMS', /** Imperial system unit of mass. */ Ounces = 'OUNCES', + /** 1 pound equals 16 ounces. */ + Pounds = 'POUNDS', } export type AssociateCustomerWithCheckoutMutationVariables = Exact<{ @@ -4998,37 +6509,103 @@ export type AssociateCustomerWithCheckoutMutationVariables = Exact<{ export type AssociateCustomerWithCheckoutMutation = { __typename?: 'Mutation' -} & { - checkoutCustomerAssociateV2?: Maybe< - { __typename?: 'CheckoutCustomerAssociateV2Payload' } & { - checkout?: Maybe<{ __typename?: 'Checkout' } & Pick> - checkoutUserErrors: Array< - { __typename?: 'CheckoutUserError' } & Pick< - CheckoutUserError, - 'code' | 'field' | 'message' - > - > - customer?: Maybe<{ __typename?: 'Customer' } & Pick> - } - > + checkoutCustomerAssociateV2?: { + __typename?: 'CheckoutCustomerAssociateV2Payload' + checkout?: { __typename?: 'Checkout'; id: string } | null + checkoutUserErrors: Array<{ + __typename?: 'CheckoutUserError' + code?: CheckoutErrorCode | null + field?: Array | null + message: string + }> + customer?: { __typename?: 'Customer'; id: string } | null + } | null } export type CheckoutCreateMutationVariables = Exact<{ - input?: Maybe + input?: InputMaybe }> -export type CheckoutCreateMutation = { __typename?: 'Mutation' } & { - checkoutCreate?: Maybe< - { __typename?: 'CheckoutCreatePayload' } & { - checkoutUserErrors: Array< - { __typename?: 'CheckoutUserError' } & Pick< - CheckoutUserError, - 'code' | 'field' | 'message' - > - > - checkout?: Maybe<{ __typename?: 'Checkout' } & CheckoutDetailsFragment> - } - > +export type CheckoutCreateMutation = { + __typename?: 'Mutation' + checkoutCreate?: { + __typename?: 'CheckoutCreatePayload' + checkoutUserErrors: Array<{ + __typename?: 'CheckoutUserError' + code?: CheckoutErrorCode | null + field?: Array | null + message: string + }> + checkout?: { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } + } | null + } | null } export type CheckoutLineItemAddMutationVariables = Exact<{ @@ -5036,18 +6613,86 @@ export type CheckoutLineItemAddMutationVariables = Exact<{ lineItems: Array | CheckoutLineItemInput }> -export type CheckoutLineItemAddMutation = { __typename?: 'Mutation' } & { - checkoutLineItemsAdd?: Maybe< - { __typename?: 'CheckoutLineItemsAddPayload' } & { - checkoutUserErrors: Array< - { __typename?: 'CheckoutUserError' } & Pick< - CheckoutUserError, - 'code' | 'field' | 'message' - > - > - checkout?: Maybe<{ __typename?: 'Checkout' } & CheckoutDetailsFragment> - } - > +export type CheckoutLineItemAddMutation = { + __typename?: 'Mutation' + checkoutLineItemsAdd?: { + __typename?: 'CheckoutLineItemsAddPayload' + checkoutUserErrors: Array<{ + __typename?: 'CheckoutUserError' + code?: CheckoutErrorCode | null + field?: Array | null + message: string + }> + checkout?: { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } + } | null + } | null } export type CheckoutLineItemRemoveMutationVariables = Exact<{ @@ -5055,18 +6700,86 @@ export type CheckoutLineItemRemoveMutationVariables = Exact<{ lineItemIds: Array | Scalars['ID'] }> -export type CheckoutLineItemRemoveMutation = { __typename?: 'Mutation' } & { - checkoutLineItemsRemove?: Maybe< - { __typename?: 'CheckoutLineItemsRemovePayload' } & { - checkoutUserErrors: Array< - { __typename?: 'CheckoutUserError' } & Pick< - CheckoutUserError, - 'code' | 'field' | 'message' - > - > - checkout?: Maybe<{ __typename?: 'Checkout' } & CheckoutDetailsFragment> - } - > +export type CheckoutLineItemRemoveMutation = { + __typename?: 'Mutation' + checkoutLineItemsRemove?: { + __typename?: 'CheckoutLineItemsRemovePayload' + checkoutUserErrors: Array<{ + __typename?: 'CheckoutUserError' + code?: CheckoutErrorCode | null + field?: Array | null + message: string + }> + checkout?: { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } + } | null + } | null } export type CheckoutLineItemUpdateMutationVariables = Exact<{ @@ -5074,58 +6787,126 @@ export type CheckoutLineItemUpdateMutationVariables = Exact<{ lineItems: Array | CheckoutLineItemUpdateInput }> -export type CheckoutLineItemUpdateMutation = { __typename?: 'Mutation' } & { - checkoutLineItemsUpdate?: Maybe< - { __typename?: 'CheckoutLineItemsUpdatePayload' } & { - checkoutUserErrors: Array< - { __typename?: 'CheckoutUserError' } & Pick< - CheckoutUserError, - 'code' | 'field' | 'message' - > - > - checkout?: Maybe<{ __typename?: 'Checkout' } & CheckoutDetailsFragment> - } - > +export type CheckoutLineItemUpdateMutation = { + __typename?: 'Mutation' + checkoutLineItemsUpdate?: { + __typename?: 'CheckoutLineItemsUpdatePayload' + checkoutUserErrors: Array<{ + __typename?: 'CheckoutUserError' + code?: CheckoutErrorCode | null + field?: Array | null + message: string + }> + checkout?: { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } + } | null + } | null } export type CustomerAccessTokenCreateMutationVariables = Exact<{ input: CustomerAccessTokenCreateInput }> -export type CustomerAccessTokenCreateMutation = { __typename?: 'Mutation' } & { - customerAccessTokenCreate?: Maybe< - { __typename?: 'CustomerAccessTokenCreatePayload' } & { - customerAccessToken?: Maybe< - { __typename?: 'CustomerAccessToken' } & Pick< - CustomerAccessToken, - 'accessToken' | 'expiresAt' - > - > - customerUserErrors: Array< - { __typename?: 'CustomerUserError' } & Pick< - CustomerUserError, - 'code' | 'field' | 'message' - > - > - } - > +export type CustomerAccessTokenCreateMutation = { + __typename?: 'Mutation' + customerAccessTokenCreate?: { + __typename?: 'CustomerAccessTokenCreatePayload' + customerAccessToken?: { + __typename?: 'CustomerAccessToken' + accessToken: string + expiresAt: any + } | null + customerUserErrors: Array<{ + __typename?: 'CustomerUserError' + code?: CustomerErrorCode | null + field?: Array | null + message: string + }> + } | null } export type CustomerAccessTokenDeleteMutationVariables = Exact<{ customerAccessToken: Scalars['String'] }> -export type CustomerAccessTokenDeleteMutation = { __typename?: 'Mutation' } & { - customerAccessTokenDelete?: Maybe< - { __typename?: 'CustomerAccessTokenDeletePayload' } & Pick< - CustomerAccessTokenDeletePayload, - 'deletedAccessToken' | 'deletedCustomerAccessTokenId' - > & { - userErrors: Array< - { __typename?: 'UserError' } & Pick - > - } - > +export type CustomerAccessTokenDeleteMutation = { + __typename?: 'Mutation' + customerAccessTokenDelete?: { + __typename?: 'CustomerAccessTokenDeletePayload' + deletedAccessToken?: string | null + deletedCustomerAccessTokenId?: string | null + userErrors: Array<{ + __typename?: 'UserError' + field?: Array | null + message: string + }> + } | null } export type CustomerActivateByUrlMutationVariables = Exact<{ @@ -5133,24 +6914,23 @@ export type CustomerActivateByUrlMutationVariables = Exact<{ password: Scalars['String'] }> -export type CustomerActivateByUrlMutation = { __typename?: 'Mutation' } & { - customerActivateByUrl?: Maybe< - { __typename?: 'CustomerActivateByUrlPayload' } & { - customer?: Maybe<{ __typename?: 'Customer' } & Pick> - customerAccessToken?: Maybe< - { __typename?: 'CustomerAccessToken' } & Pick< - CustomerAccessToken, - 'accessToken' | 'expiresAt' - > - > - customerUserErrors: Array< - { __typename?: 'CustomerUserError' } & Pick< - CustomerUserError, - 'code' | 'field' | 'message' - > - > - } - > +export type CustomerActivateByUrlMutation = { + __typename?: 'Mutation' + customerActivateByUrl?: { + __typename?: 'CustomerActivateByUrlPayload' + customer?: { __typename?: 'Customer'; id: string } | null + customerAccessToken?: { + __typename?: 'CustomerAccessToken' + accessToken: string + expiresAt: any + } | null + customerUserErrors: Array<{ + __typename?: 'CustomerUserError' + code?: CustomerErrorCode | null + field?: Array | null + message: string + }> + } | null } export type CustomerActivateMutationVariables = Exact<{ @@ -5158,236 +6938,383 @@ export type CustomerActivateMutationVariables = Exact<{ input: CustomerActivateInput }> -export type CustomerActivateMutation = { __typename?: 'Mutation' } & { - customerActivate?: Maybe< - { __typename?: 'CustomerActivatePayload' } & { - customer?: Maybe<{ __typename?: 'Customer' } & Pick> - customerAccessToken?: Maybe< - { __typename?: 'CustomerAccessToken' } & Pick< - CustomerAccessToken, - 'accessToken' | 'expiresAt' - > - > - customerUserErrors: Array< - { __typename?: 'CustomerUserError' } & Pick< - CustomerUserError, - 'code' | 'field' | 'message' - > - > - } - > +export type CustomerActivateMutation = { + __typename?: 'Mutation' + customerActivate?: { + __typename?: 'CustomerActivatePayload' + customer?: { __typename?: 'Customer'; id: string } | null + customerAccessToken?: { + __typename?: 'CustomerAccessToken' + accessToken: string + expiresAt: any + } | null + customerUserErrors: Array<{ + __typename?: 'CustomerUserError' + code?: CustomerErrorCode | null + field?: Array | null + message: string + }> + } | null } export type CustomerCreateMutationVariables = Exact<{ input: CustomerCreateInput }> -export type CustomerCreateMutation = { __typename?: 'Mutation' } & { - customerCreate?: Maybe< - { __typename?: 'CustomerCreatePayload' } & { - customerUserErrors: Array< - { __typename?: 'CustomerUserError' } & Pick< - CustomerUserError, - 'code' | 'field' | 'message' - > - > - customer?: Maybe<{ __typename?: 'Customer' } & Pick> - } - > +export type CustomerCreateMutation = { + __typename?: 'Mutation' + customerCreate?: { + __typename?: 'CustomerCreatePayload' + customerUserErrors: Array<{ + __typename?: 'CustomerUserError' + code?: CustomerErrorCode | null + field?: Array | null + message: string + }> + customer?: { __typename?: 'Customer'; id: string } | null + } | null } export type GetSiteCollectionsQueryVariables = Exact<{ first: Scalars['Int'] }> -export type GetSiteCollectionsQuery = { __typename?: 'QueryRoot' } & { - collections: { __typename?: 'CollectionConnection' } & { - edges: Array< - { __typename?: 'CollectionEdge' } & { - node: { __typename?: 'Collection' } & Pick< - Collection, - 'id' | 'title' | 'handle' - > +export type GetSiteCollectionsQuery = { + __typename?: 'QueryRoot' + collections: { + __typename?: 'CollectionConnection' + edges: Array<{ + __typename?: 'CollectionEdge' + node: { + __typename?: 'Collection' + id: string + title: string + handle: string } - > + }> } } export type GetAllPagesQueryVariables = Exact<{ - first?: Maybe + first?: InputMaybe }> -export type GetAllPagesQuery = { __typename?: 'QueryRoot' } & { - pages: { __typename?: 'PageConnection' } & { - edges: Array< - { __typename?: 'PageEdge' } & { - node: { __typename?: 'Page' } & Pick - } - > +export type GetAllPagesQuery = { + __typename?: 'QueryRoot' + pages: { + __typename?: 'PageConnection' + edges: Array<{ + __typename?: 'PageEdge' + node: { __typename?: 'Page'; id: string; title: string; handle: string } + }> } } export type GetAllProductVendorsQueryVariables = Exact<{ - first?: Maybe - cursor?: Maybe + first?: InputMaybe + cursor?: InputMaybe }> -export type GetAllProductVendorsQuery = { __typename?: 'QueryRoot' } & { - products: { __typename?: 'ProductConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ProductEdge' } & Pick & { - node: { __typename?: 'Product' } & Pick - } - > +export type GetAllProductVendorsQuery = { + __typename?: 'QueryRoot' + products: { + __typename?: 'ProductConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductEdge' + cursor: string + node: { __typename?: 'Product'; vendor: string } + }> } } export type GetAllProductPathsQueryVariables = Exact<{ - first?: Maybe - cursor?: Maybe + first?: InputMaybe + cursor?: InputMaybe }> -export type GetAllProductPathsQuery = { __typename?: 'QueryRoot' } & { - products: { __typename?: 'ProductConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ProductEdge' } & Pick & { - node: { __typename?: 'Product' } & Pick - } - > +export type GetAllProductPathsQuery = { + __typename?: 'QueryRoot' + products: { + __typename?: 'ProductConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductEdge' + cursor: string + node: { __typename?: 'Product'; handle: string } + }> } } -export type ProductConnectionFragment = { __typename?: 'ProductConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ProductEdge' } & { - node: { __typename?: 'Product' } & Pick< - Product, - 'id' | 'title' | 'vendor' | 'handle' - > & { - priceRange: { __typename?: 'ProductPriceRange' } & { - minVariantPrice: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - } - images: { __typename?: 'ImageConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ImageEdge' } & { - node: { __typename?: 'Image' } & Pick< - Image, - 'originalSrc' | 'altText' | 'width' | 'height' - > - } - > - } +export type ProductConnectionFragment = { + __typename?: 'ProductConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductEdge' + node: { + __typename?: 'Product' + id: string + title: string + vendor: string + handle: string + priceRange: { + __typename?: 'ProductPriceRange' + minVariantPrice: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode } + } + images: { + __typename?: 'ImageConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ImageEdge' + node: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } + }> + } } - > + }> } export type GetAllProductsQueryVariables = Exact<{ - first?: Maybe - query?: Maybe - sortKey?: Maybe - reverse?: Maybe + first?: InputMaybe + query?: InputMaybe + sortKey?: InputMaybe + reverse?: InputMaybe }> -export type GetAllProductsQuery = { __typename?: 'QueryRoot' } & { - products: { __typename?: 'ProductConnection' } & ProductConnectionFragment +export type GetAllProductsQuery = { + __typename?: 'QueryRoot' + products: { + __typename?: 'ProductConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductEdge' + node: { + __typename?: 'Product' + id: string + title: string + vendor: string + handle: string + priceRange: { + __typename?: 'ProductPriceRange' + minVariantPrice: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + } + images: { + __typename?: 'ImageConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ImageEdge' + node: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } + }> + } + } + }> + } } -export type CheckoutDetailsFragment = { __typename?: 'Checkout' } & Pick< - Checkout, - 'id' | 'webUrl' | 'completedAt' | 'createdAt' | 'taxesIncluded' -> & { - subtotalPriceV2: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - totalTaxV2: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - totalPriceV2: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - lineItems: { __typename?: 'CheckoutLineItemConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'CheckoutLineItemEdge' } & { - node: { __typename?: 'CheckoutLineItem' } & Pick< - CheckoutLineItem, - 'id' | 'title' | 'quantity' - > & { - variant?: Maybe< - { __typename?: 'ProductVariant' } & Pick< - ProductVariant, - 'id' | 'sku' | 'title' - > & { - image?: Maybe< - { __typename?: 'Image' } & Pick< - Image, - 'originalSrc' | 'altText' | 'width' | 'height' - > - > - priceV2: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - compareAtPriceV2?: Maybe< - { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - > - product: { __typename?: 'Product' } & Pick< - Product, - 'handle' - > - } - > - } - } - > - } +export type CheckoutDetailsFragment = { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } +} export type GetCheckoutQueryVariables = Exact<{ checkoutId: Scalars['ID'] }> -export type GetCheckoutQuery = { __typename?: 'QueryRoot' } & { - node?: Maybe< +export type GetCheckoutQuery = { + __typename?: 'QueryRoot' + node?: | { __typename?: 'AppliedGiftCard' } | { __typename?: 'Article' } | { __typename?: 'Blog' } - | ({ __typename?: 'Checkout' } & CheckoutDetailsFragment) + | { __typename?: 'Cart' } + | { __typename?: 'CartLine' } + | { + __typename?: 'Checkout' + id: string + webUrl: any + completedAt?: any | null + createdAt: any + taxesIncluded: boolean + subtotalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalTaxV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + totalPriceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + lineItems: { + __typename?: 'CheckoutLineItemConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'CheckoutLineItemEdge' + node: { + __typename?: 'CheckoutLineItem' + id: string + title: string + quantity: number + variant?: { + __typename?: 'ProductVariant' + id: string + sku?: string | null + title: string + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + image?: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } | null + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + product: { __typename?: 'Product'; handle: string } + } | null + } + }> + } + } | { __typename?: 'CheckoutLineItem' } | { __typename?: 'Collection' } | { __typename?: 'Comment' } | { __typename?: 'ExternalVideo' } + | { __typename?: 'GenericFile' } + | { __typename?: 'Location' } | { __typename?: 'MailingAddress' } | { __typename?: 'MediaImage' } + | { __typename?: 'Menu' } + | { __typename?: 'MenuItem' } | { __typename?: 'Metafield' } | { __typename?: 'Model3d' } | { __typename?: 'Order' } @@ -5396,191 +7323,268 @@ export type GetCheckoutQuery = { __typename?: 'QueryRoot' } & { | { __typename?: 'Product' } | { __typename?: 'ProductOption' } | { __typename?: 'ProductVariant' } + | { __typename?: 'Shop' } | { __typename?: 'ShopPolicy' } + | { __typename?: 'UrlRedirect' } | { __typename?: 'Video' } - > + | null } export type GetProductsFromCollectionQueryVariables = Exact<{ categoryId: Scalars['ID'] - first?: Maybe - sortKey?: Maybe - reverse?: Maybe + first?: InputMaybe + sortKey?: InputMaybe + reverse?: InputMaybe }> -export type GetProductsFromCollectionQuery = { __typename?: 'QueryRoot' } & { - node?: Maybe< - | ({ __typename?: 'AppliedGiftCard' } & Pick) - | ({ __typename?: 'Article' } & Pick) - | ({ __typename?: 'Blog' } & Pick) - | ({ __typename?: 'Checkout' } & Pick) - | ({ __typename?: 'CheckoutLineItem' } & Pick) - | ({ __typename?: 'Collection' } & Pick & { - products: { - __typename?: 'ProductConnection' - } & ProductConnectionFragment - }) - | ({ __typename?: 'Comment' } & Pick) - | ({ __typename?: 'ExternalVideo' } & Pick) - | ({ __typename?: 'MailingAddress' } & Pick) - | ({ __typename?: 'MediaImage' } & Pick) - | ({ __typename?: 'Metafield' } & Pick) - | ({ __typename?: 'Model3d' } & Pick) - | ({ __typename?: 'Order' } & Pick) - | ({ __typename?: 'Page' } & Pick) - | ({ __typename?: 'Payment' } & Pick) - | ({ __typename?: 'Product' } & Pick) - | ({ __typename?: 'ProductOption' } & Pick) - | ({ __typename?: 'ProductVariant' } & Pick) - | ({ __typename?: 'ShopPolicy' } & Pick) - | ({ __typename?: 'Video' } & Pick) - > +export type GetProductsFromCollectionQuery = { + __typename?: 'QueryRoot' + node?: + | { __typename?: 'AppliedGiftCard'; id: string } + | { __typename?: 'Article'; id: string } + | { __typename?: 'Blog'; id: string } + | { __typename?: 'Cart'; id: string } + | { __typename?: 'CartLine'; id: string } + | { __typename?: 'Checkout'; id: string } + | { __typename?: 'CheckoutLineItem'; id: string } + | { + __typename?: 'Collection' + id: string + products: { + __typename?: 'ProductConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductEdge' + node: { + __typename?: 'Product' + id: string + title: string + vendor: string + handle: string + priceRange: { + __typename?: 'ProductPriceRange' + minVariantPrice: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + } + images: { + __typename?: 'ImageConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ImageEdge' + node: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } + }> + } + } + }> + } + } + | { __typename?: 'Comment'; id: string } + | { __typename?: 'ExternalVideo'; id: string } + | { __typename?: 'GenericFile'; id: string } + | { __typename?: 'Location'; id: string } + | { __typename?: 'MailingAddress'; id: string } + | { __typename?: 'MediaImage'; id: string } + | { __typename?: 'Menu'; id: string } + | { __typename?: 'MenuItem'; id: string } + | { __typename?: 'Metafield'; id: string } + | { __typename?: 'Model3d'; id: string } + | { __typename?: 'Order'; id: string } + | { __typename?: 'Page'; id: string } + | { __typename?: 'Payment'; id: string } + | { __typename?: 'Product'; id: string } + | { __typename?: 'ProductOption'; id: string } + | { __typename?: 'ProductVariant'; id: string } + | { __typename?: 'Shop'; id: string } + | { __typename?: 'ShopPolicy'; id: string } + | { __typename?: 'UrlRedirect'; id: string } + | { __typename?: 'Video'; id: string } + | null } export type GetCustomerIdQueryVariables = Exact<{ customerAccessToken: Scalars['String'] }> -export type GetCustomerIdQuery = { __typename?: 'QueryRoot' } & { - customer?: Maybe<{ __typename?: 'Customer' } & Pick> +export type GetCustomerIdQuery = { + __typename?: 'QueryRoot' + customer?: { __typename?: 'Customer'; id: string } | null } export type GetCustomerQueryVariables = Exact<{ customerAccessToken: Scalars['String'] }> -export type GetCustomerQuery = { __typename?: 'QueryRoot' } & { - customer?: Maybe< - { __typename?: 'Customer' } & Pick< - Customer, - | 'id' - | 'firstName' - | 'lastName' - | 'displayName' - | 'email' - | 'phone' - | 'tags' - | 'acceptsMarketing' - | 'createdAt' - > - > +export type GetCustomerQuery = { + __typename?: 'QueryRoot' + customer?: { + __typename?: 'Customer' + id: string + firstName?: string | null + lastName?: string | null + displayName: string + email?: string | null + phone?: string | null + tags: Array + acceptsMarketing: boolean + createdAt: any + } | null } export type GetPageQueryVariables = Exact<{ id: Scalars['ID'] }> -export type GetPageQuery = { __typename?: 'QueryRoot' } & { - node?: Maybe< - | ({ __typename?: 'AppliedGiftCard' } & Pick) - | ({ __typename?: 'Article' } & Pick) - | ({ __typename?: 'Blog' } & Pick) - | ({ __typename?: 'Checkout' } & Pick) - | ({ __typename?: 'CheckoutLineItem' } & Pick) - | ({ __typename?: 'Collection' } & Pick) - | ({ __typename?: 'Comment' } & Pick) - | ({ __typename?: 'ExternalVideo' } & Pick) - | ({ __typename?: 'MailingAddress' } & Pick) - | ({ __typename?: 'MediaImage' } & Pick) - | ({ __typename?: 'Metafield' } & Pick) - | ({ __typename?: 'Model3d' } & Pick) - | ({ __typename?: 'Order' } & Pick) - | ({ __typename?: 'Page' } & Pick< - Page, - 'title' | 'handle' | 'body' | 'bodySummary' | 'id' - >) - | ({ __typename?: 'Payment' } & Pick) - | ({ __typename?: 'Product' } & Pick) - | ({ __typename?: 'ProductOption' } & Pick) - | ({ __typename?: 'ProductVariant' } & Pick) - | ({ __typename?: 'ShopPolicy' } & Pick) - | ({ __typename?: 'Video' } & Pick) - > +export type GetPageQuery = { + __typename?: 'QueryRoot' + node?: + | { __typename?: 'AppliedGiftCard'; id: string } + | { __typename?: 'Article'; id: string } + | { __typename?: 'Blog'; id: string } + | { __typename?: 'Cart'; id: string } + | { __typename?: 'CartLine'; id: string } + | { __typename?: 'Checkout'; id: string } + | { __typename?: 'CheckoutLineItem'; id: string } + | { __typename?: 'Collection'; id: string } + | { __typename?: 'Comment'; id: string } + | { __typename?: 'ExternalVideo'; id: string } + | { __typename?: 'GenericFile'; id: string } + | { __typename?: 'Location'; id: string } + | { __typename?: 'MailingAddress'; id: string } + | { __typename?: 'MediaImage'; id: string } + | { __typename?: 'Menu'; id: string } + | { __typename?: 'MenuItem'; id: string } + | { __typename?: 'Metafield'; id: string } + | { __typename?: 'Model3d'; id: string } + | { __typename?: 'Order'; id: string } + | { + __typename?: 'Page' + title: string + handle: string + body: any + bodySummary: string + id: string + } + | { __typename?: 'Payment'; id: string } + | { __typename?: 'Product'; id: string } + | { __typename?: 'ProductOption'; id: string } + | { __typename?: 'ProductVariant'; id: string } + | { __typename?: 'Shop'; id: string } + | { __typename?: 'ShopPolicy'; id: string } + | { __typename?: 'UrlRedirect'; id: string } + | { __typename?: 'Video'; id: string } + | null } export type GetProductBySlugQueryVariables = Exact<{ slug: Scalars['String'] }> -export type GetProductBySlugQuery = { __typename?: 'QueryRoot' } & { - productByHandle?: Maybe< - { __typename?: 'Product' } & Pick< - Product, - | 'id' - | 'handle' - | 'title' - | 'productType' - | 'vendor' - | 'description' - | 'descriptionHtml' - > & { - options: Array< - { __typename?: 'ProductOption' } & Pick< - ProductOption, - 'id' | 'name' | 'values' - > - > - priceRange: { __typename?: 'ProductPriceRange' } & { - maxVariantPrice: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - minVariantPrice: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - } - variants: { __typename?: 'ProductVariantConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ProductVariantEdge' } & { - node: { __typename?: 'ProductVariant' } & Pick< - ProductVariant, - 'id' | 'title' | 'sku' - > & { - selectedOptions: Array< - { __typename?: 'SelectedOption' } & Pick< - SelectedOption, - 'name' | 'value' - > - > - priceV2: { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - compareAtPriceV2?: Maybe< - { __typename?: 'MoneyV2' } & Pick< - MoneyV2, - 'amount' | 'currencyCode' - > - > - } - } - > - } - images: { __typename?: 'ImageConnection' } & { - pageInfo: { __typename?: 'PageInfo' } & Pick< - PageInfo, - 'hasNextPage' | 'hasPreviousPage' - > - edges: Array< - { __typename?: 'ImageEdge' } & { - node: { __typename?: 'Image' } & Pick< - Image, - 'originalSrc' | 'altText' | 'width' | 'height' - > - } - > - } +export type GetProductBySlugQuery = { + __typename?: 'QueryRoot' + productByHandle?: { + __typename?: 'Product' + id: string + handle: string + availableForSale: boolean + title: string + productType: string + vendor: string + description: string + descriptionHtml: any + options: Array<{ + __typename?: 'ProductOption' + id: string + name: string + values: Array + }> + priceRange: { + __typename?: 'ProductPriceRange' + maxVariantPrice: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode } - > + minVariantPrice: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + } + variants: { + __typename?: 'ProductVariantConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ProductVariantEdge' + node: { + __typename?: 'ProductVariant' + id: string + title: string + sku?: string | null + availableForSale: boolean + requiresShipping: boolean + selectedOptions: Array<{ + __typename?: 'SelectedOption' + name: string + value: string + }> + priceV2: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } + compareAtPriceV2?: { + __typename?: 'MoneyV2' + amount: any + currencyCode: CurrencyCode + } | null + } + }> + } + images: { + __typename?: 'ImageConnection' + pageInfo: { + __typename?: 'PageInfo' + hasNextPage: boolean + hasPreviousPage: boolean + } + edges: Array<{ + __typename?: 'ImageEdge' + node: { + __typename?: 'Image' + originalSrc: any + altText?: string | null + width?: number | null + height?: number | null + } + }> + } + } | null } export type GetSiteInfoQueryVariables = Exact<{ [key: string]: never }> -export type GetSiteInfoQuery = { __typename?: 'QueryRoot' } & { - shop: { __typename?: 'Shop' } & Pick +export type GetSiteInfoQuery = { + __typename?: 'QueryRoot' + shop: { __typename?: 'Shop'; name: string } } diff --git a/packages/shopify/schema.graphql b/packages/shopify/schema.graphql index 9c657fe43..d2e600fb9 100644 --- a/packages/shopify/schema.graphql +++ b/packages/shopify/schema.graphql @@ -14,18 +14,26 @@ directive @accessRestricted( ) on FIELD_DEFINITION | OBJECT """ -Contextualize data. +Contextualizes data based on the additional information provided by the directive. For example, you can use the `@inContext(country: CA)` directive to [query a product's price](https://shopify.dev/api/examples/international-pricing#query-product-prices) in a storefront within the context of Canada. """ directive @inContext( """ - The country code for context. + The country code for context. For example, `CA`. """ - country: CountryCode! -) on QUERY | MUTATION + country: CountryCode -""" -A version of the API. -""" + """ + The language code for context. For example, `EN`. + """ + language: LanguageCode + + """ + The identifier of the customer's preferred location. + """ + preferredLocationId: ID +) on MUTATION | QUERY + +"A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).\nVersions are commonly referred to by their handle (for example, `2021-10`).\n" type ApiVersion { """ The human-readable name of the version. @@ -38,7 +46,7 @@ type ApiVersion { handle: String! """ - Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/concepts/about-apis/versioning). + Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning). """ supported: Boolean! } @@ -50,7 +58,7 @@ type AppliedGiftCard implements Node { """ The amount that was taken from the gift card by applying it. """ - amountUsed: Money! @deprecated(reason: "Use `amountUsedV2` instead") + amountUsed: Money! @deprecated(reason: "Use `amountUsedV2` instead.") """ The amount that was taken from the gift card by applying it. @@ -60,7 +68,7 @@ type AppliedGiftCard implements Node { """ The amount left on the gift card. """ - balance: Money! @deprecated(reason: "Use `balanceV2` instead") + balance: Money! @deprecated(reason: "Use `balanceV2` instead.") """ The amount left on the gift card. @@ -68,7 +76,7 @@ type AppliedGiftCard implements Node { balanceV2: MoneyV2! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -86,11 +94,11 @@ type AppliedGiftCard implements Node { """ An article in an online store blog. """ -type Article implements Node { +type Article implements HasMetafields & Node & OnlineStorePublishable { """ The article's author. """ - author: ArticleAuthor! @deprecated(reason: "Use `authorV2` instead") + author: ArticleAuthor! @deprecated(reason: "Use `authorV2` instead.") """ The article's author. @@ -106,26 +114,26 @@ type Article implements Node { List of comments posted on the article. """ comments( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -162,40 +170,46 @@ type Article implements Node { """ excerptHtml: HTML - """ - A human-friendly unique string for the Article automatically generated from its title. - """ + "A human-friendly unique string for the Article automatically generated from its title.\n" handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! """ The image associated with the article. """ - image( + image: Image + + """ + Returns a metafield found by namespace and key. + """ + metafield( """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. + The identifier for the metafield. """ - maxWidth: Int + key: String! """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. + A container for a set of metafields. """ - maxHeight: Int + namespace: String! + ): Metafield + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. + The list of metafields to retrieve by namespace and key. """ - crop: CropRegion + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image + """ + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. + """ + onlineStoreUrl: URL """ The date and time when the article was published. @@ -216,11 +230,6 @@ type Article implements Node { The article’s name. """ title: String! - - """ - The url pointing to the article accessible from the web. - """ - url: URL! } """ @@ -253,24 +262,25 @@ type ArticleAuthor { name: String! } -""" -An auto-generated type for paginating through multiple Articles. -""" +"An auto-generated type for paginating through multiple Articles.\n" type ArticleConnection { """ A list of edges. """ edges: [ArticleEdge!]! + """ + A list of the nodes contained in ArticleEdge. + """ + nodes: [Article!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Article and a cursor during pagination. -""" +"An auto-generated type which holds one Article and a cursor during pagination.\n" type ArticleEdge { """ A cursor for use in pagination. @@ -288,9 +298,9 @@ The set of valid sort keys for the Article query. """ enum ArticleSortKeys { """ - Sort by the `title` value. + Sort by the `author` value. """ - TITLE + AUTHOR """ Sort by the `blog_title` value. @@ -298,31 +308,27 @@ enum ArticleSortKeys { BLOG_TITLE """ - Sort by the `author` value. + Sort by the `id` value. """ - AUTHOR - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT + ID """ Sort by the `published_at` value. """ PUBLISHED_AT - """ - Sort by the `id` value. - """ - ID + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `title` value. """ - RELEVANCE + TITLE + + """ + Sort by the `updated_at` value. + """ + UPDATED_AT } """ @@ -355,9 +361,7 @@ input AttributeInput { value: String! } -""" -Automatic discount applications capture the intentions of a discount that was automatically applied. -""" +"Automatic discount applications capture the intentions of a discount that was automatically applied.\n" type AutomaticDiscountApplication implements DiscountApplication { """ The method by which the discount's value is allocated to its entitled items. @@ -389,11 +393,7 @@ type AutomaticDiscountApplication implements DiscountApplication { A collection of available shipping rates for a checkout. """ type AvailableShippingRates { - """ - Whether or not the shipping rates are ready. - The `shippingRates` field is `null` when this value is `false`. - This field should be polled until its value becomes `true`. - """ + "Whether or not the shipping rates are ready.\nThe `shippingRates` field is `null` when this value is `false`.\nThis field should be polled until its value becomes `true`.\n" ready: Boolean! """ @@ -405,7 +405,7 @@ type AvailableShippingRates { """ An online store blog. """ -type Blog implements Node { +type Blog implements HasMetafields & Node & OnlineStorePublishable { """ Find an article by its handle. """ @@ -420,25 +420,28 @@ type Blog implements Node { List of the blog's articles. """ articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `author`\n - `blog_title`\n - `created_at`\n - `tag`\n - `tag_not`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -449,19 +452,6 @@ type Blog implements Node { Sort the underlying list by the given key. """ sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): ArticleConnection! """ @@ -469,16 +459,42 @@ type Blog implements Node { """ authors: [ArticleAuthor!]! - """ - A human-friendly unique string for the Blog automatically generated from its title. - """ + "A human-friendly unique string for the Blog automatically generated from its title.\n" handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! + """ + Returns a metafield found by namespace and key. + """ + metafield( + """ + The identifier for the metafield. + """ + key: String! + + """ + A container for a set of metafields. + """ + namespace: String! + ): Metafield + + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( + """ + The list of metafields to retrieve by namespace and key. + """ + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! + + """ + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. + """ + onlineStoreUrl: URL + """ The blog's SEO information. """ @@ -488,31 +504,27 @@ type Blog implements Node { The blogs’s title. """ title: String! - - """ - The url pointing to the blog accessible from the web. - """ - url: URL! } -""" -An auto-generated type for paginating through multiple Blogs. -""" +"An auto-generated type for paginating through multiple Blogs.\n" type BlogConnection { """ A list of edges. """ edges: [BlogEdge!]! + """ + A list of the nodes contained in BlogEdge. + """ + nodes: [Blog!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Blog and a cursor during pagination. -""" +"An auto-generated type which holds one Blog and a cursor during pagination.\n" type BlogEdge { """ A cursor for use in pagination. @@ -534,43 +546,24 @@ enum BlogSortKeys { """ HANDLE - """ - Sort by the `title` value. - """ - TITLE - """ Sort by the `id` value. """ ID - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" RELEVANCE + + """ + Sort by the `title` value. + """ + TITLE } """ Card brand, such as Visa or Mastercard, which can be used for payments. """ enum CardBrand { - """ - Visa. - """ - VISA - - """ - Mastercard. - """ - MASTERCARD - - """ - Discover. - """ - DISCOVER - """ American Express. """ @@ -581,10 +574,853 @@ enum CardBrand { """ DINERS_CLUB + """ + Discover. + """ + DISCOVER + """ JCB. """ JCB + + """ + Mastercard. + """ + MASTERCARD + + """ + Visa. + """ + VISA +} + +""" +A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. To learn how to interact with a cart during a customer's session, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). +""" +type Cart implements Node { + """ + An attribute associated with the cart. + """ + attribute( + """ + The key of the attribute. + """ + key: String! + ): Attribute + + """ + The attributes associated with the cart. Attributes are represented as key-value pairs. + """ + attributes: [Attribute!]! + + """ + Information about the buyer that is interacting with the cart. + """ + buyerIdentity: CartBuyerIdentity! + + """ + The URL of the checkout for the cart. + """ + checkoutUrl: URL! + + """ + The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). + """ + cost: CartCost! + + """ + The date and time when the cart was created. + """ + createdAt: DateTime! + + """ + The delivery groups available for the cart, based on the default address of the logged-in customer. + """ + deliveryGroups( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): CartDeliveryGroupConnection! + + """ + The discounts that have been applied to the entire cart. + """ + discountAllocations: [CartDiscountAllocation!]! + + "The case-insensitive discount codes that the customer added at checkout.\n" + discountCodes: [CartDiscountCode!]! + + """ + The estimated costs that the buyer will pay at checkout. The estimated costs are subject to change and changes will be reflected at checkout. The `estimatedCost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart). + """ + estimatedCost: CartEstimatedCost! @deprecated(reason: "Use `cost` instead.") + + """ + A globally-unique identifier. + """ + id: ID! + + """ + A list of lines containing information about the items the customer intends to purchase. + """ + lines( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): CartLineConnection! + + """ + A note that is associated with the cart. For example, the note can be a personalized message to the buyer. + """ + note: String + + """ + The total number of items in the cart. + """ + totalQuantity: Int! + + """ + The date and time when the cart was updated. + """ + updatedAt: DateTime! +} + +""" +Return type for `cartAttributesUpdate` mutation. +""" +type CartAttributesUpdatePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +The discounts automatically applied to the cart line based on prerequisites that have been met. +""" +type CartAutomaticDiscountAllocation implements CartDiscountAllocation { + """ + The discounted amount that has been applied to the cart line. + """ + discountedAmount: MoneyV2! + + """ + The title of the allocated discount. + """ + title: String! +} + +""" +Represents information about the buyer that is interacting with the cart. +""" +type CartBuyerIdentity { + """ + The country where the buyer is located. + """ + countryCode: CountryCode + + """ + The customer account associated with the cart. + """ + customer: Customer + + """ + The email address of the buyer that is interacting with the cart. + """ + email: String + + """ + The phone number of the buyer that is interacting with the cart. + """ + phone: String +} + +"Specifies the input fields to update the buyer information associated with a cart.\nBuyer identity is used to determine\n[international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout)\nand should match the customer's shipping address.\n" +input CartBuyerIdentityInput { + """ + The country where the buyer is located. + """ + countryCode: CountryCode + + """ + The access token used to identify the customer associated with the cart. + """ + customerAccessToken: String + + """ + The email address of the buyer that is interacting with the cart. + """ + email: String + + """ + The phone number of the buyer that is interacting with the cart. + """ + phone: String +} + +""" +Return type for `cartBuyerIdentityUpdate` mutation. +""" +type CartBuyerIdentityUpdatePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +The discount that has been applied to the cart line using a discount code. +""" +type CartCodeDiscountAllocation implements CartDiscountAllocation { + """ + The code used to apply the discount. + """ + code: String! + + """ + The discounted amount that has been applied to the cart line. + """ + discountedAmount: MoneyV2! +} + +"The costs that the buyer will pay at checkout.\nIt uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine\n[international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart).\n" +type CartCost { + """ + The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to `subtotalAmount`. + """ + checkoutChargeAmount: MoneyV2! + + """ + The amount, before taxes and cart-level discounts, for the customer to pay. + """ + subtotalAmount: MoneyV2! + + """ + Whether the subtotal amount is estimated. + """ + subtotalAmountEstimated: Boolean! + + """ + The total amount for the customer to pay. + """ + totalAmount: MoneyV2! + + """ + Whether the total amount is estimated. + """ + totalAmountEstimated: Boolean! + + """ + The duty amount for the customer to pay at checkout. + """ + totalDutyAmount: MoneyV2 + + """ + Whether the total duty amount is estimated. + """ + totalDutyAmountEstimated: Boolean! + + """ + The tax amount for the customer to pay at checkout. + """ + totalTaxAmount: MoneyV2 + + """ + Whether the total tax amount is estimated. + """ + totalTaxAmountEstimated: Boolean! +} + +""" +Return type for `cartCreate` mutation. +""" +type CartCreatePayload { + """ + The new cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +The discounts automatically applied to the cart line based on prerequisites that have been met. +""" +type CartCustomDiscountAllocation implements CartDiscountAllocation { + """ + The discounted amount that has been applied to the cart line. + """ + discountedAmount: MoneyV2! + + """ + The title of the allocated discount. + """ + title: String! +} + +""" +Information about the options available for one or more line items to be delivered to a specific address. +""" +type CartDeliveryGroup { + """ + A list of cart lines for the delivery group. + """ + cartLines( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): CartLineConnection! + + """ + The destination address for the delivery group. + """ + deliveryAddress: MailingAddress! + + """ + The delivery options available for the delivery group. + """ + deliveryOptions: [CartDeliveryOption!]! + + """ + The ID for the delivery group. + """ + id: ID! +} + +"An auto-generated type for paginating through multiple CartDeliveryGroups.\n" +type CartDeliveryGroupConnection { + """ + A list of edges. + """ + edges: [CartDeliveryGroupEdge!]! + + """ + A list of the nodes contained in CartDeliveryGroupEdge. + """ + nodes: [CartDeliveryGroup!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination.\n" +type CartDeliveryGroupEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of CartDeliveryGroupEdge. + """ + node: CartDeliveryGroup! +} + +""" +Information about a delivery option. +""" +type CartDeliveryOption { + """ + The code of the delivery option. + """ + code: String + + """ + The method for the delivery option. + """ + deliveryMethodType: DeliveryMethodType! + + """ + The description of the delivery option. + """ + description: String + + """ + The estimated cost for the delivery option. + """ + estimatedCost: MoneyV2! + + """ + The title of the delivery option. + """ + title: String +} + +""" +The discounts that have been applied to the cart line. +""" +interface CartDiscountAllocation { + """ + The discounted amount that has been applied to the cart line. + """ + discountedAmount: MoneyV2! +} + +""" +The discount codes applied to the cart. +""" +type CartDiscountCode { + """ + Whether the discount code is applicable to the cart's current contents. + """ + applicable: Boolean! + + """ + The code for the discount. + """ + code: String! +} + +""" +Return type for `cartDiscountCodesUpdate` mutation. +""" +type CartDiscountCodesUpdatePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +Possible error codes that can be returned by `CartUserError`. +""" +enum CartErrorCode { + """ + The input value is invalid. + """ + INVALID + + """ + Merchandise line was not found in cart. + """ + INVALID_MERCHANDISE_LINE + + """ + The input value should be less than the maximum value allowed. + """ + LESS_THAN + + """ + Missing discount code. + """ + MISSING_DISCOUNT_CODE + + """ + Missing note. + """ + MISSING_NOTE +} + +"The estimated costs that the buyer will pay at checkout.\nIt uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine\n[international pricing](https://shopify.dev/api/examples/international-pricing#create-a-cart).\n" +type CartEstimatedCost { + """ + 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`. + """ + checkoutChargeAmount: MoneyV2! + + """ + The estimated amount, before taxes and discounts, for the customer to pay. + """ + subtotalAmount: MoneyV2! + + """ + The estimated total amount for the customer to pay. + """ + totalAmount: MoneyV2! + + """ + The estimated duty amount for the customer to pay at checkout. + """ + totalDutyAmount: MoneyV2 + + """ + The estimated tax amount for the customer to pay at checkout. + """ + totalTaxAmount: MoneyV2 +} + +""" +Specifies the input fields to create a cart. +""" +input CartInput { + """ + An array of key-value pairs that contains additional information about the cart. + """ + attributes: [AttributeInput!] + + """ + The customer associated with the cart. Used to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout). Buyer identity should match the customer's shipping address. + """ + buyerIdentity: CartBuyerIdentityInput + + "The case-insensitive discount codes that the customer added at checkout.\n" + discountCodes: [String!] + + """ + A list of merchandise lines to add to the cart. + """ + lines: [CartLineInput!] + + """ + A note that is associated with the cart. For example, the note can be a personalized message to the buyer. + """ + note: String +} + +""" +Represents information about the merchandise in the cart. +""" +type CartLine implements Node { + """ + An attribute associated with the cart line. + """ + attribute( + """ + The key of the attribute. + """ + key: String! + ): Attribute + + """ + The attributes associated with the cart line. Attributes are represented as key-value pairs. + """ + attributes: [Attribute!]! + + """ + The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. + """ + cost: CartLineCost! + + """ + The discounts that have been applied to the cart line. + """ + discountAllocations: [CartDiscountAllocation!]! + + """ + The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout. + """ + estimatedCost: CartLineEstimatedCost! + @deprecated(reason: "Use `cost` instead.") + + """ + A globally-unique identifier. + """ + id: ID! + + """ + The merchandise that the buyer intends to purchase. + """ + merchandise: Merchandise! + + """ + The quantity of the merchandise that the customer intends to purchase. + """ + quantity: Int! + + """ + The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. + """ + sellingPlanAllocation: SellingPlanAllocation +} + +"An auto-generated type for paginating through multiple CartLines.\n" +type CartLineConnection { + """ + A list of edges. + """ + edges: [CartLineEdge!]! + + """ + A list of the nodes contained in CartLineEdge. + """ + nodes: [CartLine!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +The cost of the merchandise line that the buyer will pay at checkout. +""" +type CartLineCost { + """ + The amount of the merchandise line. + """ + amountPerQuantity: MoneyV2! + + """ + The compare at amount of the merchandise line. + """ + compareAtAmountPerQuantity: MoneyV2 + + """ + The cost of the merchandise line before line-level discounts. + """ + subtotalAmount: MoneyV2! + + """ + The total cost of the merchandise line. + """ + totalAmount: MoneyV2! +} + +"An auto-generated type which holds one CartLine and a cursor during pagination.\n" +type CartLineEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of CartLineEdge. + """ + node: CartLine! +} + +""" +The estimated cost of the merchandise line that the buyer will pay at checkout. +""" +type CartLineEstimatedCost { + """ + The amount of the merchandise line. + """ + amount: MoneyV2! + + """ + The compare at amount of the merchandise line. + """ + compareAtAmount: MoneyV2 + + """ + The estimated cost of the merchandise line before discounts. + """ + subtotalAmount: MoneyV2! + + """ + The estimated total cost of the merchandise line. + """ + totalAmount: MoneyV2! +} + +""" +Specifies the input fields to create a merchandise line on a cart. +""" +input CartLineInput { + """ + An array of key-value pairs that contains additional information about the merchandise line. + """ + attributes: [AttributeInput!] + + """ + The identifier of the merchandise that the buyer intends to purchase. + """ + merchandiseId: ID! + + """ + The quantity of the merchandise. + """ + quantity: Int = 1 + + """ + The identifier of the selling plan that the merchandise is being purchased with. + """ + sellingPlanId: ID +} + +""" +Specifies the input fields to update a line item on a cart. +""" +input CartLineUpdateInput { + """ + An array of key-value pairs that contains additional information about the merchandise line. + """ + attributes: [AttributeInput!] + + """ + The identifier of the merchandise line. + """ + id: ID! + + """ + The identifier of the merchandise for the line item. + """ + merchandiseId: ID + + """ + The quantity of the line item. + """ + quantity: Int + + """ + The identifier of the selling plan that the merchandise is being purchased with. + """ + sellingPlanId: ID +} + +""" +Return type for `cartLinesAdd` mutation. +""" +type CartLinesAddPayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +Return type for `cartLinesRemove` mutation. +""" +type CartLinesRemovePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +Return type for `cartLinesUpdate` mutation. +""" +type CartLinesUpdatePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +Return type for `cartNoteUpdate` mutation. +""" +type CartNoteUpdatePayload { + """ + The updated cart. + """ + cart: Cart + + """ + The list of errors that occurred from executing the mutation. + """ + userErrors: [CartUserError!]! +} + +""" +Represents an error that happens during execution of a cart mutation. +""" +type CartUserError implements DisplayableError { + """ + The error code. + """ + code: CartErrorCode + + """ + The path to the input field that caused the error. + """ + field: [String!] + + """ + The error message. + """ + message: String! } """ @@ -596,13 +1432,14 @@ type Checkout implements Node { """ appliedGiftCards: [AppliedGiftCard!]! - """ - The available shipping rates for this Checkout. - Should only be used when checkout `requiresShipping` is `true` and - the shipping address is valid. - """ + "The available shipping rates for this Checkout.\nShould only be used when checkout `requiresShipping` is `true` and\nthe shipping address is valid.\n" availableShippingRates: AvailableShippingRates + """ + The identity of the customer associated with the checkout. + """ + buyerIdentity: CheckoutBuyerIdentity! + """ The date and time when the checkout was completed. """ @@ -614,7 +1451,7 @@ type Checkout implements Node { createdAt: DateTime! """ - The currency code for the Checkout. + The currency code for the checkout. """ currencyCode: CurrencyCode! @@ -623,38 +1460,30 @@ type Checkout implements Node { """ customAttributes: [Attribute!]! - """ - The customer associated with the checkout. - """ - customer: Customer - @deprecated( - reason: "This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it." - ) - """ Discounts that have been applied on the checkout. """ discountApplications( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -667,7 +1496,7 @@ type Checkout implements Node { email: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -675,26 +1504,26 @@ type Checkout implements Node { A list of line item objects, each one containing information about an item in the checkout. """ lineItems( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -724,19 +1553,14 @@ type Checkout implements Node { """ The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards. """ - paymentDue: Money! @deprecated(reason: "Use `paymentDueV2` instead") + paymentDue: Money! @deprecated(reason: "Use `paymentDueV2` instead.") """ - The amount left to be paid. This is equal to the cost of the line items, duties, taxes and shipping minus discounts and gift cards. + The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards. """ paymentDueV2: MoneyV2! - """ - Whether or not the Checkout is ready and can be completed. Checkouts may - have asynchronous operations that can take time to finish. If you want - to complete a checkout or ensure all the fields are populated and up to - date, polling is required until the value is true. - """ + "Whether or not the Checkout is ready and can be completed. Checkouts may\nhave asynchronous operations that can take time to finish. If you want\nto complete a checkout or ensure all the fields are populated and up to\ndate, polling is required until the value is true.\n" ready: Boolean! """ @@ -749,9 +1573,7 @@ type Checkout implements Node { """ shippingAddress: MailingAddress - """ - The discounts that have been allocated onto the shipping line by discount applications. - """ + "The discounts that have been allocated onto the shipping line by discount applications.\n" shippingDiscountAllocations: [DiscountAllocation!]! """ @@ -762,37 +1584,42 @@ type Checkout implements Node { """ Price of the checkout before shipping and taxes. """ - subtotalPrice: Money! @deprecated(reason: "Use `subtotalPriceV2` instead") + subtotalPrice: Money! @deprecated(reason: "Use `subtotalPriceV2` instead.") """ - Price of the checkout before duties, shipping and taxes. + The price at checkout before duties, shipping, and taxes. """ subtotalPriceV2: MoneyV2! """ - Specifies if the Checkout is tax exempt. + Whether the checkout is tax exempt. """ taxExempt: Boolean! """ - Specifies if taxes are included in the line item and shipping line prices. + Whether taxes are included in the line item and shipping line prices. """ taxesIncluded: Boolean! """ - The sum of all the prices of all the items in the checkout, taxes and discounts included. + The sum of all the duties applied to the line items in the checkout. """ - totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead") + totalDuties: MoneyV2 """ - The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. + The sum of all the prices of all the items in the checkout, taxes and discounts included. + """ + totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead.") + + """ + The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts. """ totalPriceV2: MoneyV2! """ The sum of all the taxes applied to the line items and shipping lines in the checkout. """ - totalTax: Money! @deprecated(reason: "Use `totalTaxV2` instead") + totalTax: Money! @deprecated(reason: "Use `totalTaxV2` instead.") """ The sum of all the taxes applied to the line items and shipping lines in the checkout. @@ -810,57 +1637,12 @@ type Checkout implements Node { webUrl: URL! } -""" -Specifies the fields required to update a checkout's attributes. -""" -input CheckoutAttributesUpdateInput { - """ - The text of an optional note that a shop owner can attach to the checkout. - """ - note: String - - """ - A list of extra information that is added to the checkout. - """ - customAttributes: [AttributeInput!] - - """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of the addresses is still done at complete time. - """ - allowPartialAddresses: Boolean -} - -""" -Return type for `checkoutAttributesUpdate` mutation. -""" -type CheckoutAttributesUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - """ Specifies the fields required to update a checkout's attributes. """ input CheckoutAttributesUpdateV2Input { - """ - The text of an optional note that a shop owner can attach to the checkout. - """ - note: String + "Allows setting partial addresses on a Checkout, skipping the full validation of attributes.\nThe required attributes are city, province, and country.\nFull validation of the addresses is still done at completion time. Defaults to `false` with \neach operation.\n" + allowPartialAddresses: Boolean = false """ A list of extra information that is added to the checkout. @@ -868,11 +1650,9 @@ input CheckoutAttributesUpdateV2Input { customAttributes: [AttributeInput!] """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of the addresses is still done at complete time. + The text of an optional note that a shop owner can attach to the checkout. """ - allowPartialAddresses: Boolean + note: String } """ @@ -885,15 +1665,33 @@ type CheckoutAttributesUpdateV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") +} + +""" +The identity of the customer associated with the checkout. +""" +type CheckoutBuyerIdentity { + """ + The country code for the checkout. For example, `CA`. + """ + countryCode: CountryCode +} + +""" +Specifies the identity of the customer associated with the checkout. +""" +input CheckoutBuyerIdentityInput { + "The country code of one of the shop's\n[enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup).\nFor example, `CA`. Including this field creates a checkout in the specified country's currency.\n" + countryCode: CountryCode! } """ @@ -906,41 +1704,15 @@ type CheckoutCompleteFreePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithCreditCard` mutation. -""" -type CheckoutCompleteWithCreditCardPayload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -953,7 +1725,7 @@ type CheckoutCompleteWithCreditCardV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! @@ -963,62 +1735,10 @@ type CheckoutCompleteWithCreditCardV2Payload { payment: Payment """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithTokenizedPayment` mutation. -""" -type CheckoutCompleteWithTokenizedPaymentPayload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithTokenizedPaymentV2` mutation. -""" -type CheckoutCompleteWithTokenizedPaymentV2Payload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1031,7 +1751,7 @@ type CheckoutCompleteWithTokenizedPaymentV3Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! @@ -1041,16 +1761,29 @@ type CheckoutCompleteWithTokenizedPaymentV3Payload { payment: Payment """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ Specifies the fields required to create a checkout. """ input CheckoutCreateInput { + "Allows setting partial addresses on a Checkout, skipping the full validation of attributes.\nThe required attributes are city, province, and country.\nFull validation of addresses is still done at completion time. Defaults to `null`.\n" + allowPartialAddresses: Boolean + + """ + The identity of the customer associated with the checkout. + """ + buyerIdentity: CheckoutBuyerIdentityInput + + """ + A list of extra information that is added to the checkout. + """ + customAttributes: [AttributeInput!] + """ The email with which the customer wants to checkout. """ @@ -1061,34 +1794,15 @@ input CheckoutCreateInput { """ lineItems: [CheckoutLineItemInput!] - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput - """ The text of an optional note that a shop owner can attach to the checkout. """ note: String """ - A list of extra information that is added to the checkout. + The shipping address to where the line items will be shipped. """ - customAttributes: [AttributeInput!] - - """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of addresses is still done at complete time. - """ - allowPartialAddresses: Boolean - - """ - The three-letter currency code of one of the shop's enabled presentment currencies. - Including this field creates a checkout in the specified currency. By default, new - checkouts are created in the shop's primary currency. - """ - presentmentCurrencyCode: CurrencyCode + shippingAddress: MailingAddressInput } """ @@ -1101,35 +1815,20 @@ type CheckoutCreatePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCustomerAssociate` mutation. -""" -type CheckoutCustomerAssociatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - The associated customer object. - """ - customer: Customer - - """ - List of errors that occurred executing the mutation. + The checkout queue token. Available only to selected stores. + """ + queueToken: String + + """ + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1142,7 +1841,7 @@ type CheckoutCustomerAssociateV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! @@ -1152,31 +1851,10 @@ type CheckoutCustomerAssociateV2Payload { customer: Customer """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCustomerDisassociate` mutation. -""" -type CheckoutCustomerDisassociatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1189,36 +1867,15 @@ type CheckoutCustomerDisassociateV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutDiscountCodeApply` mutation. -""" -type CheckoutDiscountCodeApplyPayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1231,15 +1888,15 @@ type CheckoutDiscountCodeApplyV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1252,36 +1909,15 @@ type CheckoutDiscountCodeRemovePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutEmailUpdate` mutation. -""" -type CheckoutEmailUpdatePayload { - """ - The checkout object with the updated email. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1294,145 +1930,35 @@ type CheckoutEmailUpdateV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ -Possible error codes that could be returned by CheckoutUserError. +Possible error codes that can be returned by `CheckoutUserError`. """ enum CheckoutErrorCode { - """ - Input value is blank. - """ - BLANK - - """ - Input value is invalid. - """ - INVALID - - """ - Input value is too long. - """ - TOO_LONG - - """ - Input value is not present. - """ - PRESENT - - """ - Input value should be less than maximum allowed value. - """ - LESS_THAN - - """ - Input value should be greater than or equal to minimum allowed value. - """ - GREATER_THAN_OR_EQUAL_TO - - """ - Input value should be less or equal to maximum allowed value. - """ - LESS_THAN_OR_EQUAL_TO - """ Checkout is already completed. """ ALREADY_COMPLETED - """ - Checkout is locked. - """ - LOCKED - - """ - Input value is not supported. - """ - NOT_SUPPORTED - """ Input email contains an invalid domain name. """ BAD_DOMAIN """ - Input Zip is invalid for country provided. + The input value is blank. """ - INVALID_FOR_COUNTRY - - """ - Input Zip is invalid for country and province provided. - """ - INVALID_FOR_COUNTRY_AND_PROVINCE - - """ - Invalid state in country. - """ - INVALID_STATE_IN_COUNTRY - - """ - Invalid province in country. - """ - INVALID_PROVINCE_IN_COUNTRY - - """ - Invalid region in country. - """ - INVALID_REGION_IN_COUNTRY - - """ - Shipping rate expired. - """ - SHIPPING_RATE_EXPIRED - - """ - Gift card cannot be applied to a checkout that contains a gift card. - """ - GIFT_CARD_UNUSABLE - - """ - Gift card is disabled. - """ - GIFT_CARD_DISABLED - - """ - Gift card code is invalid. - """ - GIFT_CARD_CODE_INVALID - - """ - Gift card has already been applied. - """ - GIFT_CARD_ALREADY_APPLIED - - """ - Gift card currency does not match checkout currency. - """ - GIFT_CARD_CURRENCY_MISMATCH - - """ - Gift card is expired. - """ - GIFT_CARD_EXPIRED - - """ - Gift card has no funds left. - """ - GIFT_CARD_DEPLETED - - """ - Gift card was not found. - """ - GIFT_CARD_NOT_FOUND + BLANK """ Cart does not meet discount requirements notice. @@ -1440,15 +1966,25 @@ enum CheckoutErrorCode { CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE """ - Discount expired. + Customer already used once per customer discount notice. """ - DISCOUNT_EXPIRED + CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE + + """ + Discount already applied. + """ + DISCOUNT_ALREADY_APPLIED """ Discount disabled. """ DISCOUNT_DISABLED + """ + Discount expired. + """ + DISCOUNT_EXPIRED + """ Discount limit reached. """ @@ -1459,87 +1995,175 @@ enum CheckoutErrorCode { """ DISCOUNT_NOT_FOUND - """ - Customer already used once per customer discount notice. - """ - CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE - """ Checkout is already completed. """ EMPTY """ - Not enough in stock. + Queue token has expired. """ - NOT_ENOUGH_IN_STOCK + EXPIRED_QUEUE_TOKEN """ - Missing payment input. + Gift card has already been applied. """ - MISSING_PAYMENT_INPUT + GIFT_CARD_ALREADY_APPLIED """ - The amount of the payment does not match the value to be paid. + Gift card code is invalid. """ - TOTAL_PRICE_MISMATCH + GIFT_CARD_CODE_INVALID + + """ + Gift card currency does not match checkout currency. + """ + GIFT_CARD_CURRENCY_MISMATCH + + """ + Gift card has no funds left. + """ + GIFT_CARD_DEPLETED + + """ + Gift card is disabled. + """ + GIFT_CARD_DISABLED + + """ + Gift card is expired. + """ + GIFT_CARD_EXPIRED + + """ + Gift card was not found. + """ + GIFT_CARD_NOT_FOUND + + """ + Gift card cannot be applied to a checkout that contains a gift card. + """ + GIFT_CARD_UNUSABLE + + """ + The input value should be greater than or equal to the minimum value allowed. + """ + GREATER_THAN_OR_EQUAL_TO + + """ + Higher value discount applied. + """ + HIGHER_VALUE_DISCOUNT_APPLIED + + """ + The input value is invalid. + """ + INVALID + + """ + Cannot specify country and presentment currency code. + """ + INVALID_COUNTRY_AND_CURRENCY + + """ + Input Zip is invalid for country provided. + """ + INVALID_FOR_COUNTRY + + """ + Input Zip is invalid for country and province provided. + """ + INVALID_FOR_COUNTRY_AND_PROVINCE + + """ + Invalid province in country. + """ + INVALID_PROVINCE_IN_COUNTRY + + """ + Queue token is invalid. + """ + INVALID_QUEUE_TOKEN + + """ + Invalid region in country. + """ + INVALID_REGION_IN_COUNTRY + + """ + Invalid state in country. + """ + INVALID_STATE_IN_COUNTRY + + """ + The input value should be less than the maximum value allowed. + """ + LESS_THAN + + """ + The input value should be less than or equal to the maximum value allowed. + """ + LESS_THAN_OR_EQUAL_TO """ Line item was not found in checkout. """ LINE_ITEM_NOT_FOUND + """ + Checkout is locked. + """ + LOCKED + + """ + Maximum number of discount codes limit reached. + """ + MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED + + """ + Missing payment input. + """ + MISSING_PAYMENT_INPUT + + """ + Not enough in stock. + """ + NOT_ENOUGH_IN_STOCK + + """ + Input value is not supported. + """ + NOT_SUPPORTED + + """ + The input value needs to be blank. + """ + PRESENT + + """ + Shipping rate expired. + """ + SHIPPING_RATE_EXPIRED + + """ + Throttled during checkout. + """ + THROTTLED_DURING_CHECKOUT + + """ + The input value is too long. + """ + TOO_LONG + + """ + The amount of the payment does not match the value to be paid. + """ + TOTAL_PRICE_MISMATCH + """ Unable to apply discount. """ UNABLE_TO_APPLY - - """ - Discount already applied. - """ - DISCOUNT_ALREADY_APPLIED -} - -""" -Return type for `checkoutGiftCardApply` mutation. -""" -type CheckoutGiftCardApplyPayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutGiftCardRemove` mutation. -""" -type CheckoutGiftCardRemovePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") } """ @@ -1552,15 +2176,15 @@ type CheckoutGiftCardRemoveV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1573,15 +2197,15 @@ type CheckoutGiftCardsAppendPayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1599,7 +2223,7 @@ type CheckoutLineItem implements Node { discountAllocations: [DiscountAllocation!]! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -1624,24 +2248,25 @@ type CheckoutLineItem implements Node { variant: ProductVariant } -""" -An auto-generated type for paginating through multiple CheckoutLineItems. -""" +"An auto-generated type for paginating through multiple CheckoutLineItems.\n" type CheckoutLineItemConnection { """ A list of edges. """ edges: [CheckoutLineItemEdge!]! + """ + A list of the nodes contained in CheckoutLineItemEdge. + """ + nodes: [CheckoutLineItem!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. -""" +"An auto-generated type which holds one CheckoutLineItem and a cursor during pagination.\n" type CheckoutLineItemEdge { """ A cursor for use in pagination. @@ -1678,25 +2303,25 @@ input CheckoutLineItemInput { Specifies the input fields to update a line item on the checkout. """ input CheckoutLineItemUpdateInput { + """ + Extra information in the form of an array of Key-Value pairs about the line item. + """ + customAttributes: [AttributeInput!] + """ The identifier of the line item. """ id: ID - """ - The variant identifier of the line item. - """ - variantId: ID - """ The quantity of the line item. """ quantity: Int """ - Extra information in the form of an array of Key-Value pairs about the line item. + The variant identifier of the line item. """ - customAttributes: [AttributeInput!] + variantId: ID } """ @@ -1709,15 +2334,15 @@ type CheckoutLineItemsAddPayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1730,15 +2355,15 @@ type CheckoutLineItemsRemovePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1751,7 +2376,7 @@ type CheckoutLineItemsReplacePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [CheckoutUserError!]! } @@ -1766,36 +2391,15 @@ type CheckoutLineItemsUpdatePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutShippingAddressUpdate` mutation. -""" -type CheckoutShippingAddressUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1808,15 +2412,15 @@ type CheckoutShippingAddressUpdateV2Payload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1829,15 +2433,15 @@ type CheckoutShippingLineUpdatePayload { checkout: Checkout """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ checkoutUserErrors: [CheckoutUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") + @deprecated(reason: "Use `checkoutUserErrors` instead.") } """ @@ -1845,12 +2449,12 @@ Represents an error that happens during execution of a checkout mutation. """ type CheckoutUserError implements DisplayableError { """ - Error code to uniquely identify the error. + The error code. """ code: CheckoutErrorCode """ - Path to the input field which caused the error. + The path to the input field that caused the error. """ field: [String!] @@ -1863,7 +2467,7 @@ type CheckoutUserError implements DisplayableError { """ A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. """ -type Collection implements Node { +type Collection implements HasMetafields & Node & OnlineStorePublishable { """ Stripped description of the collection, single line with HTML tags removed. """ @@ -1879,66 +2483,76 @@ type Collection implements Node { """ descriptionHtml: HTML! - """ - A human-friendly unique string for the collection automatically generated from its title. - Limit of 255 characters. - """ + "A human-friendly unique string for the collection automatically generated from its title.\nLimit of 255 characters.\n" handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! """ Image associated with the collection. """ - image( + image: Image + + """ + Returns a metafield found by namespace and key. + """ + metafield( """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. + The identifier for the metafield. """ - maxWidth: Int + key: String! """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. + A container for a set of metafields. """ - maxHeight: Int + namespace: String! + ): Metafield + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. + The list of metafields to retrieve by namespace and key. """ - crop: CropRegion + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image + """ + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. + """ + onlineStoreUrl: URL """ List of products in the collection. """ products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns a subset of products matching all product filters. + """ + filters: [ProductFilter!] + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -1950,6 +2564,11 @@ type Collection implements Node { sortKey: ProductCollectionSortKeys = COLLECTION_DEFAULT ): ProductConnection! + """ + The collection's SEO information. + """ + seo: SEO! + """ The collection’s name. Limit of 255 characters. """ @@ -1961,24 +2580,25 @@ type Collection implements Node { updatedAt: DateTime! } -""" -An auto-generated type for paginating through multiple Collections. -""" +"An auto-generated type for paginating through multiple Collections.\n" type CollectionConnection { """ A list of edges. """ edges: [CollectionEdge!]! + """ + A list of the nodes contained in CollectionEdge. + """ + nodes: [Collection!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Collection and a cursor during pagination. -""" +"An auto-generated type which holds one Collection and a cursor during pagination.\n" type CollectionEdge { """ A cursor for use in pagination. @@ -1995,6 +2615,14 @@ type CollectionEdge { The set of valid sort keys for the Collection query. """ enum CollectionSortKeys { + """ + Sort by the `id` value. + """ + ID + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE + """ Sort by the `title` value. """ @@ -2004,18 +2632,6 @@ enum CollectionSortKeys { Sort by the `updated_at` value. """ UPDATED_AT - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE } """ @@ -2043,7 +2659,7 @@ type Comment implements Node { contentHtml: HTML! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! } @@ -2063,24 +2679,25 @@ type CommentAuthor { name: String! } -""" -An auto-generated type for paginating through multiple Comments. -""" +"An auto-generated type for paginating through multiple Comments.\n" type CommentConnection { """ A list of edges. """ edges: [CommentEdge!]! + """ + A list of the nodes contained in CommentEdge. + """ + nodes: [Comment!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Comment and a cursor during pagination. -""" +"An auto-generated type which holds one Comment and a cursor during pagination.\n" type CommentEdge { """ A cursor for use in pagination. @@ -2094,28 +2711,41 @@ type CommentEdge { } """ -ISO 3166-1 alpha-2 country codes with some differences. +A country. """ +type Country { + """ + The languages available for the country. + """ + availableLanguages: [Language!]! + + """ + The currency of the country. + """ + currency: Currency! + + """ + The ISO code of the country. + """ + isoCode: CountryCode! + + """ + The name of the country. + """ + name: String! + + """ + The unit system used in the country. + """ + unitSystem: UnitSystem! +} + +"The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.\nIf a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision\nof another country. For example, the territories associated with Spain are represented by the country code `ES`,\nand the territories associated with the United States of America are represented by the country code `US`.\n" enum CountryCode { """ - Afghanistan. + Ascension Island. """ - AF - - """ - Åland Islands. - """ - AX - - """ - Albania. - """ - AL - - """ - Algeria. - """ - DZ + AC """ Andorra. @@ -2123,14 +2753,14 @@ enum CountryCode { AD """ - Angola. + United Arab Emirates. """ - AO + AE """ - Anguilla. + Afghanistan. """ - AI + AF """ Antigua & Barbuda. @@ -2138,9 +2768,14 @@ enum CountryCode { AG """ - Argentina. + Anguilla. """ - AR + AI + + """ + Albania. + """ + AL """ Armenia. @@ -2148,144 +2783,109 @@ enum CountryCode { AM """ - Aruba. + Netherlands Antilles. """ - AW + AN """ - Ascension Island. + Angola. """ - AC + AO """ - Australia. + Argentina. """ - AU + AR """ Austria. """ AT + """ + Australia. + """ + AU + + """ + Aruba. + """ + AW + + """ + Åland Islands. + """ + AX + """ Azerbaijan. """ AZ - """ - Bahamas. - """ - BS - - """ - Bahrain. - """ - BH - - """ - Bangladesh. - """ - BD - - """ - Barbados. - """ - BB - - """ - Belarus. - """ - BY - - """ - Belgium. - """ - BE - - """ - Belize. - """ - BZ - - """ - Benin. - """ - BJ - - """ - Bermuda. - """ - BM - - """ - Bhutan. - """ - BT - - """ - Bolivia. - """ - BO - """ Bosnia & Herzegovina. """ BA """ - Botswana. + Barbados. """ - BW + BB """ - Bouvet Island. + Bangladesh. """ - BV + BD """ - Brazil. + Belgium. """ - BR - - """ - British Indian Ocean Territory. - """ - IO - - """ - Brunei. - """ - BN - - """ - Bulgaria. - """ - BG + BE """ Burkina Faso. """ BF + """ + Bulgaria. + """ + BG + + """ + Bahrain. + """ + BH + """ Burundi. """ BI """ - Cambodia. + Benin. """ - KH + BJ """ - Canada. + St. Barthélemy. """ - CA + BL """ - Cape Verde. + Bermuda. """ - CV + BM + + """ + Brunei. + """ + BN + + """ + Bolivia. + """ + BO """ Caribbean Netherlands. @@ -2293,34 +2893,44 @@ enum CountryCode { BQ """ - Cayman Islands. + Brazil. """ - KY + BR """ - Central African Republic. + Bahamas. """ - CF + BS """ - Chad. + Bhutan. """ - TD + BT """ - Chile. + Bouvet Island. """ - CL + BV """ - China. + Botswana. """ - CN + BW """ - Christmas Island. + Belarus. """ - CX + BY + + """ + Belize. + """ + BZ + + """ + Canada. + """ + CA """ Cocos (Keeling) Islands. @@ -2328,14 +2938,14 @@ enum CountryCode { CC """ - Colombia. + Congo - Kinshasa. """ - CO + CD """ - Comoros. + Central African Republic. """ - KM + CF """ Congo - Brazzaville. @@ -2343,35 +2953,65 @@ enum CountryCode { CG """ - Congo - Kinshasa. + Switzerland. """ - CD + CH + + """ + Côte d’Ivoire. + """ + CI """ Cook Islands. """ CK + """ + Chile. + """ + CL + + """ + Cameroon. + """ + CM + + """ + China. + """ + CN + + """ + Colombia. + """ + CO + """ Costa Rica. """ CR - """ - Croatia. - """ - HR - """ Cuba. """ CU + """ + Cape Verde. + """ + CV + """ Curaçao. """ CW + """ + Christmas Island. + """ + CX + """ Cyprus. """ @@ -2383,20 +3023,20 @@ enum CountryCode { CZ """ - Côte d’Ivoire. + Germany. """ - CI - - """ - Denmark. - """ - DK + DE """ Djibouti. """ DJ + """ + Denmark. + """ + DK + """ Dominica. """ @@ -2407,46 +3047,56 @@ enum CountryCode { """ DO + """ + Algeria. + """ + DZ + """ Ecuador. """ EC - """ - Egypt. - """ - EG - - """ - El Salvador. - """ - SV - - """ - Equatorial Guinea. - """ - GQ - - """ - Eritrea. - """ - ER - """ Estonia. """ EE """ - Eswatini. + Egypt. """ - SZ + EG + + """ + Western Sahara. + """ + EH + + """ + Eritrea. + """ + ER + + """ + Spain. + """ + ES """ Ethiopia. """ ET + """ + Finland. + """ + FI + + """ + Fiji. + """ + FJ + """ Falkland Islands. """ @@ -2457,45 +3107,25 @@ enum CountryCode { """ FO - """ - Fiji. - """ - FJ - - """ - Finland. - """ - FI - """ France. """ FR - """ - French Guiana. - """ - GF - - """ - French Polynesia. - """ - PF - - """ - French Southern Territories. - """ - TF - """ Gabon. """ GA """ - Gambia. + United Kingdom. """ - GM + GB + + """ + Grenada. + """ + GD """ Georgia. @@ -2503,9 +3133,14 @@ enum CountryCode { GE """ - Germany. + French Guiana. """ - DE + GF + + """ + Guernsey. + """ + GG """ Ghana. @@ -2517,41 +3152,46 @@ enum CountryCode { """ GI - """ - Greece. - """ - GR - """ Greenland. """ GL """ - Grenada. + Gambia. """ - GD + GM + + """ + Guinea. + """ + GN """ Guadeloupe. """ GP + """ + Equatorial Guinea. + """ + GQ + + """ + Greece. + """ + GR + + """ + South Georgia & South Sandwich Islands. + """ + GS + """ Guatemala. """ GT - """ - Guernsey. - """ - GG - - """ - Guinea. - """ - GN - """ Guinea-Bissau. """ @@ -2563,124 +3203,144 @@ enum CountryCode { GY """ - Haiti. + Hong Kong SAR. """ - HT + HK """ Heard & McDonald Islands. """ HM - """ - Vatican City. - """ - VA - """ Honduras. """ HN """ - Hong Kong SAR. + Croatia. """ - HK + HR + + """ + Haiti. + """ + HT """ Hungary. """ HU - """ - Iceland. - """ - IS - - """ - India. - """ - IN - """ Indonesia. """ ID - """ - Iran. - """ - IR - - """ - Iraq. - """ - IQ - """ Ireland. """ IE + """ + Israel. + """ + IL + """ Isle of Man. """ IM """ - Israel. + India. """ - IL + IN + + """ + British Indian Ocean Territory. + """ + IO + + """ + Iraq. + """ + IQ + + """ + Iran. + """ + IR + + """ + Iceland. + """ + IS """ Italy. """ IT - """ - Jamaica. - """ - JM - - """ - Japan. - """ - JP - """ Jersey. """ JE + """ + Jamaica. + """ + JM + """ Jordan. """ JO """ - Kazakhstan. + Japan. """ - KZ + JP """ Kenya. """ KE + """ + Kyrgyzstan. + """ + KG + + """ + Cambodia. + """ + KH + """ Kiribati. """ KI + """ + Comoros. + """ + KM + + """ + St. Kitts & Nevis. + """ + KN + """ North Korea. """ KP """ - Kosovo. + South Korea. """ - XK + KR """ Kuwait. @@ -2688,29 +3348,39 @@ enum CountryCode { KW """ - Kyrgyzstan. + Cayman Islands. """ - KG + KY + + """ + Kazakhstan. + """ + KZ """ Laos. """ LA - """ - Latvia. - """ - LV - """ Lebanon. """ LB """ - Lesotho. + St. Lucia. """ - LS + LC + + """ + Liechtenstein. + """ + LI + + """ + Sri Lanka. + """ + LK """ Liberia. @@ -2718,14 +3388,9 @@ enum CountryCode { LR """ - Libya. + Lesotho. """ - LY - - """ - Liechtenstein. - """ - LI + LS """ Lithuania. @@ -2738,9 +3403,39 @@ enum CountryCode { LU """ - Macao SAR. + Latvia. """ - MO + LV + + """ + Libya. + """ + LY + + """ + Morocco. + """ + MA + + """ + Monaco. + """ + MC + + """ + Moldova. + """ + MD + + """ + Montenegro. + """ + ME + + """ + St. Martin. + """ + MF """ Madagascar. @@ -2748,19 +3443,9 @@ enum CountryCode { MG """ - Malawi. + North Macedonia. """ - MW - - """ - Malaysia. - """ - MY - - """ - Maldives. - """ - MV + MK """ Mali. @@ -2768,9 +3453,19 @@ enum CountryCode { ML """ - Malta. + Myanmar (Burma). """ - MT + MM + + """ + Mongolia. + """ + MN + + """ + Macao SAR. + """ + MO """ Martinique. @@ -2782,15 +3477,30 @@ enum CountryCode { """ MR + """ + Montserrat. + """ + MS + + """ + Malta. + """ + MT + """ Mauritius. """ MU """ - Mayotte. + Maldives. """ - YT + MV + + """ + Malawi. + """ + MW """ Mexico. @@ -2798,180 +3508,145 @@ enum CountryCode { MX """ - Moldova. + Malaysia. """ - MD - - """ - Monaco. - """ - MC - - """ - Mongolia. - """ - MN - - """ - Montenegro. - """ - ME - - """ - Montserrat. - """ - MS - - """ - Morocco. - """ - MA + MY """ Mozambique. """ MZ - """ - Myanmar (Burma). - """ - MM - """ Namibia. """ NA - """ - Nauru. - """ - NR - - """ - Nepal. - """ - NP - - """ - Netherlands. - """ - NL - - """ - Netherlands Antilles. - """ - AN - """ New Caledonia. """ NC - """ - New Zealand. - """ - NZ - - """ - Nicaragua. - """ - NI - """ Niger. """ NE - """ - Nigeria. - """ - NG - - """ - Niue. - """ - NU - """ Norfolk Island. """ NF """ - North Macedonia. + Nigeria. """ - MK + NG + + """ + Nicaragua. + """ + NI + + """ + Netherlands. + """ + NL """ Norway. """ NO + """ + Nepal. + """ + NP + + """ + Nauru. + """ + NR + + """ + Niue. + """ + NU + + """ + New Zealand. + """ + NZ + """ Oman. """ OM - """ - Pakistan. - """ - PK - - """ - Palestinian Territories. - """ - PS - """ Panama. """ PA - """ - Papua New Guinea. - """ - PG - - """ - Paraguay. - """ - PY - """ Peru. """ PE + """ + French Polynesia. + """ + PF + + """ + Papua New Guinea. + """ + PG + """ Philippines. """ PH """ - Pitcairn Islands. + Pakistan. """ - PN + PK """ Poland. """ PL + """ + St. Pierre & Miquelon. + """ + PM + + """ + Pitcairn Islands. + """ + PN + + """ + Palestinian Territories. + """ + PS + """ Portugal. """ PT + """ + Paraguay. + """ + PY + """ Qatar. """ QA - """ - Cameroon. - """ - CM - """ Réunion. """ @@ -2982,6 +3657,11 @@ enum CountryCode { """ RO + """ + Serbia. + """ + RS + """ Russia. """ @@ -2992,140 +3672,20 @@ enum CountryCode { """ RW - """ - St. Barthélemy. - """ - BL - - """ - St. Helena. - """ - SH - - """ - St. Kitts & Nevis. - """ - KN - - """ - St. Lucia. - """ - LC - - """ - St. Martin. - """ - MF - - """ - St. Pierre & Miquelon. - """ - PM - - """ - Samoa. - """ - WS - - """ - San Marino. - """ - SM - - """ - São Tomé & Príncipe. - """ - ST - """ Saudi Arabia. """ SA - """ - Senegal. - """ - SN - - """ - Serbia. - """ - RS - - """ - Seychelles. - """ - SC - - """ - Sierra Leone. - """ - SL - - """ - Singapore. - """ - SG - - """ - Sint Maarten. - """ - SX - - """ - Slovakia. - """ - SK - - """ - Slovenia. - """ - SI - """ Solomon Islands. """ SB """ - Somalia. + Seychelles. """ - SO - - """ - South Africa. - """ - ZA - - """ - South Georgia & South Sandwich Islands. - """ - GS - - """ - South Korea. - """ - KR - - """ - South Sudan. - """ - SS - - """ - Spain. - """ - ES - - """ - Sri Lanka. - """ - LK - - """ - St. Vincent & Grenadines. - """ - VC + SC """ Sudan. @@ -3133,9 +3693,24 @@ enum CountryCode { SD """ - Suriname. + Sweden. """ - SR + SE + + """ + Singapore. + """ + SG + + """ + St. Helena. + """ + SH + + """ + Slovenia. + """ + SI """ Svalbard & Jan Mayen. @@ -3143,14 +3718,54 @@ enum CountryCode { SJ """ - Sweden. + Slovakia. """ - SE + SK """ - Switzerland. + Sierra Leone. """ - CH + SL + + """ + San Marino. + """ + SM + + """ + Senegal. + """ + SN + + """ + Somalia. + """ + SO + + """ + Suriname. + """ + SR + + """ + South Sudan. + """ + SS + + """ + São Tomé & Príncipe. + """ + ST + + """ + El Salvador. + """ + SV + + """ + Sint Maarten. + """ + SX """ Syria. @@ -3158,49 +3773,9 @@ enum CountryCode { SY """ - Taiwan. + Eswatini. """ - TW - - """ - Tajikistan. - """ - TJ - - """ - Tanzania. - """ - TZ - - """ - Thailand. - """ - TH - - """ - Timor-Leste. - """ - TL - - """ - Togo. - """ - TG - - """ - Tokelau. - """ - TK - - """ - Tonga. - """ - TO - - """ - Trinidad & Tobago. - """ - TT + SZ """ Tristan da Cunha. @@ -3208,14 +3783,44 @@ enum CountryCode { TA """ - Tunisia. + Turks & Caicos Islands. """ - TN + TC """ - Turkey. + Chad. """ - TR + TD + + """ + French Southern Territories. + """ + TF + + """ + Togo. + """ + TG + + """ + Thailand. + """ + TH + + """ + Tajikistan. + """ + TJ + + """ + Tokelau. + """ + TK + + """ + Timor-Leste. + """ + TL """ Turkmenistan. @@ -3223,9 +3828,24 @@ enum CountryCode { TM """ - Turks & Caicos Islands. + Tunisia. """ - TC + TN + + """ + Tonga. + """ + TO + + """ + Turkey. + """ + TR + + """ + Trinidad & Tobago. + """ + TT """ Tuvalu. @@ -3233,9 +3853,14 @@ enum CountryCode { TV """ - Uganda. + Taiwan. """ - UG + TW + + """ + Tanzania. + """ + TZ """ Ukraine. @@ -3243,25 +3868,20 @@ enum CountryCode { UA """ - United Arab Emirates. + Uganda. """ - AE - - """ - United Kingdom. - """ - GB - - """ - United States. - """ - US + UG """ U.S. Outlying Islands. """ UM + """ + United States. + """ + US + """ Uruguay. """ @@ -3273,24 +3893,34 @@ enum CountryCode { UZ """ - Vanuatu. + Vatican City. """ - VU + VA + + """ + St. Vincent & Grenadines. + """ + VC """ Venezuela. """ VE + """ + British Virgin Islands. + """ + VG + """ Vietnam. """ VN """ - British Virgin Islands. + Vanuatu. """ - VG + VU """ Wallis & Futuna. @@ -3298,15 +3928,30 @@ enum CountryCode { WF """ - Western Sahara. + Samoa. """ - EH + WS + + """ + Kosovo. + """ + XK """ Yemen. """ YE + """ + Mayotte. + """ + YT + + """ + South Africa. + """ + ZA + """ Zambia. """ @@ -3316,6 +3961,11 @@ enum CountryCode { Zimbabwe. """ ZW + + """ + Unknown Region. + """ + ZZ } """ @@ -3363,87 +4013,48 @@ type CreditCard { maskedNumber: String } -""" -Specifies the fields required to complete a checkout with -a Shopify vaulted credit card payment. -""" -input CreditCardPaymentInput { - """ - The amount of the payment. - """ - amount: Money! - - """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). - """ - idempotencyKey: String! - +"Specifies the fields required to complete a checkout with\na Shopify vaulted credit card payment.\n" +input CreditCardPaymentInputV2 { """ The billing address for the payment. """ billingAddress: MailingAddressInput! """ - The ID returned by Shopify's Card Vault. + A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). """ - vaultId: String! + idempotencyKey: String! - """ - Executes the payment in test mode if possible. Defaults to `false`. - """ - test: Boolean -} - -""" -Specifies the fields required to complete a checkout with -a Shopify vaulted credit card payment. -""" -input CreditCardPaymentInputV2 { """ The amount and currency of the payment. """ paymentAmount: MoneyInput! """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). + Executes the payment in test mode if possible. Defaults to `false`. """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! + test: Boolean = false """ The ID returned by Shopify's Card Vault. """ vaultId: String! - - """ - Executes the payment in test mode if possible. Defaults to `false`. - """ - test: Boolean } """ The part of the image that should remain after cropping. """ enum CropRegion { - """ - Keep the center of the image. - """ - CENTER - - """ - Keep the top of the image. - """ - TOP - """ Keep the bottom of the image. """ BOTTOM + """ + Keep the center of the image. + """ + CENTER + """ Keep the left of the image. """ @@ -3453,31 +4064,39 @@ enum CropRegion { Keep the right of the image. """ RIGHT + + """ + Keep the top of the image. + """ + TOP } """ -Currency codes. +A currency. """ +type Currency { + """ + The ISO code of the currency. + """ + isoCode: CurrencyCode! + + """ + The name of the currency. + """ + name: String! + + """ + The symbol of the currency. + """ + symbol: String! +} + +"The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,\nand non-standard codes.\n" enum CurrencyCode { """ - United States Dollars (USD). + United Arab Emirates Dirham (AED). """ - USD - - """ - Euro (EUR). - """ - EUR - - """ - United Kingdom Pounds (GBP). - """ - GBP - - """ - Canadian Dollars (CAD). - """ - CAD + AED """ Afghan Afghani (AFN). @@ -3490,9 +4109,14 @@ enum CurrencyCode { ALL """ - Algerian Dinar (DZD). + Armenian Dram (AMD). """ - DZD + AMD + + """ + Netherlands Antillean Guilder. + """ + ANG """ Angolan Kwanza (AOA). @@ -3505,9 +4129,9 @@ enum CurrencyCode { ARS """ - Armenian Dram (AMD). + Australian Dollars (AUD). """ - AMD + AUD """ Aruban Florin (AWG). @@ -3515,29 +4139,29 @@ enum CurrencyCode { AWG """ - Australian Dollars (AUD). + Azerbaijani Manat (AZN). """ - AUD + AZN + + """ + Bosnia and Herzegovina Convertible Mark (BAM). + """ + BAM """ Barbadian Dollar (BBD). """ BBD - """ - Azerbaijani Manat (AZN). - """ - AZN - """ Bangladesh Taka (BDT). """ BDT """ - Bahamian Dollar (BSD). + Bulgarian Lev (BGN). """ - BSD + BGN """ Bahraini Dinar (BHD). @@ -3549,75 +4173,73 @@ enum CurrencyCode { """ BIF - """ - Belize Dollar (BZD). - """ - BZD - """ Bermudian Dollar (BMD). """ BMD - """ - Bhutanese Ngultrum (BTN). - """ - BTN - - """ - Bosnia and Herzegovina Convertible Mark (BAM). - """ - BAM - - """ - Brazilian Real (BRL). - """ - BRL - - """ - Bolivian Boliviano (BOB). - """ - BOB - - """ - Botswana Pula (BWP). - """ - BWP - """ Brunei Dollar (BND). """ BND """ - Bulgarian Lev (BGN). + Bolivian Boliviano (BOB). """ - BGN + BOB """ - Burmese Kyat (MMK). + Brazilian Real (BRL). """ - MMK + BRL """ - Cambodian Riel. + Bahamian Dollar (BSD). """ - KHR + BSD """ - Cape Verdean escudo (CVE). + Bhutanese Ngultrum (BTN). """ - CVE + BTN """ - Cayman Dollars (KYD). + Botswana Pula (BWP). """ - KYD + BWP """ - Central African CFA Franc (XAF). + Belarusian Ruble (BYN). """ - XAF + BYN + + """ + Belarusian Ruble (BYR). + """ + BYR + @deprecated( + reason: "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead." + ) + + """ + Belize Dollar (BZD). + """ + BZD + + """ + Canadian Dollars (CAD). + """ + CAD + + """ + Congolese franc (CDF). + """ + CDF + + """ + Swiss Francs (CHF). + """ + CHF """ Chilean Peso (CLP). @@ -3634,31 +4256,26 @@ enum CurrencyCode { """ COP - """ - Comorian Franc (KMF). - """ - KMF - - """ - Congolese franc (CDF). - """ - CDF - """ Costa Rican Colones (CRC). """ CRC """ - Croatian Kuna (HRK). + Cape Verdean escudo (CVE). """ - HRK + CVE """ Czech Koruny (CZK). """ CZK + """ + Djiboutian Franc (DJF). + """ + DJF + """ Danish Kroner (DKK). """ @@ -3670,24 +4287,29 @@ enum CurrencyCode { DOP """ - East Caribbean Dollar (XCD). + Algerian Dinar (DZD). """ - XCD + DZD """ Egyptian Pound (EGP). """ EGP + """ + Eritrean Nakfa (ERN). + """ + ERN + """ Ethiopian Birr (ETB). """ ETB """ - CFP Franc (XPF). + Euro (EUR). """ - XPF + EUR """ Fijian Dollars (FJD). @@ -3695,15 +4317,40 @@ enum CurrencyCode { FJD """ - Gambian Dalasi (GMD). + Falkland Islands Pounds (FKP). """ - GMD + FKP + + """ + United Kingdom Pounds (GBP). + """ + GBP + + """ + Georgian Lari (GEL). + """ + GEL """ Ghanaian Cedi (GHS). """ GHS + """ + Gibraltar Pounds (GIP). + """ + GIP + + """ + Gambian Dalasi (GMD). + """ + GMD + + """ + Guinean Franc (GNF). + """ + GNF + """ Guatemalan Quetzal (GTQ). """ @@ -3715,14 +4362,9 @@ enum CurrencyCode { GYD """ - Georgian Lari (GEL). + Hong Kong Dollars (HKD). """ - GEL - - """ - Haitian Gourde (HTG). - """ - HTG + HKD """ Honduran Lempira (HNL). @@ -3730,25 +4372,20 @@ enum CurrencyCode { HNL """ - Hong Kong Dollars (HKD). + Croatian Kuna (HRK). """ - HKD + HRK + + """ + Haitian Gourde (HTG). + """ + HTG """ Hungarian Forint (HUF). """ HUF - """ - Icelandic Kronur (ISK). - """ - ISK - - """ - Indian Rupees (INR). - """ - INR - """ Indonesian Rupiah (IDR). """ @@ -3759,81 +4396,141 @@ enum CurrencyCode { """ ILS + """ + Indian Rupees (INR). + """ + INR + """ Iraqi Dinar (IQD). """ IQD """ - Jamaican Dollars (JMD). + Iranian Rial (IRR). """ - JMD + IRR """ - Japanese Yen (JPY). + Icelandic Kronur (ISK). """ - JPY + ISK """ Jersey Pound. """ JEP + """ + Jamaican Dollars (JMD). + """ + JMD + """ Jordanian Dinar (JOD). """ JOD """ - Kazakhstani Tenge (KZT). + Japanese Yen (JPY). """ - KZT + JPY """ Kenyan Shilling (KES). """ KES + """ + Kyrgyzstani Som (KGS). + """ + KGS + + """ + Cambodian Riel. + """ + KHR + + """ + Kiribati Dollar (KID). + """ + KID + + """ + Comorian Franc (KMF). + """ + KMF + + """ + South Korean Won (KRW). + """ + KRW + """ Kuwaiti Dinar (KWD). """ KWD """ - Kyrgyzstani Som (KGS). + Cayman Dollars (KYD). """ - KGS + KYD + + """ + Kazakhstani Tenge (KZT). + """ + KZT """ Laotian Kip (LAK). """ LAK - """ - Latvian Lati (LVL). - """ - LVL - """ Lebanese Pounds (LBP). """ LBP """ - Lesotho Loti (LSL). + Sri Lankan Rupees (LKR). """ - LSL + LKR """ Liberian Dollar (LRD). """ LRD + """ + Lesotho Loti (LSL). + """ + LSL + """ Lithuanian Litai (LTL). """ LTL + """ + Latvian Lati (LVL). + """ + LVL + + """ + Libyan Dinar (LYD). + """ + LYD + + """ + Moroccan Dirham. + """ + MAD + + """ + Moldovan Leu (MDL). + """ + MDL + """ Malagasy Ariary (MGA). """ @@ -3844,21 +4541,41 @@ enum CurrencyCode { """ MKD + """ + Burmese Kyat (MMK). + """ + MMK + + """ + Mongolian Tugrik. + """ + MNT + """ Macanese Pataca (MOP). """ MOP """ - Malawian Kwacha (MWK). + Mauritanian Ouguiya (MRU). """ - MWK + MRU + + """ + Mauritian Rupee (MUR). + """ + MUR """ Maldivian Rufiyaa (MVR). """ MVR + """ + Malawian Kwacha (MWK). + """ + MWK + """ Mexican Pesos (MXN). """ @@ -3869,26 +4586,6 @@ enum CurrencyCode { """ MYR - """ - Mauritian Rupee (MUR). - """ - MUR - - """ - Moldovan Leu (MDL). - """ - MDL - - """ - Moroccan Dirham. - """ - MAD - - """ - Mongolian Tugrik. - """ - MNT - """ Mozambican Metical. """ @@ -3900,35 +4597,30 @@ enum CurrencyCode { NAD """ - Nepalese Rupee (NPR). + Nigerian Naira (NGN). """ - NPR - - """ - Netherlands Antillean Guilder. - """ - ANG - - """ - New Zealand Dollars (NZD). - """ - NZD + NGN """ Nicaraguan Córdoba (NIO). """ NIO - """ - Nigerian Naira (NGN). - """ - NGN - """ Norwegian Kroner (NOK). """ NOK + """ + Nepalese Rupee (NPR). + """ + NPR + + """ + New Zealand Dollars (NZD). + """ + NZD + """ Omani Rial (OMR). """ @@ -3940,35 +4632,35 @@ enum CurrencyCode { PAB """ - Pakistani Rupee (PKR). + Peruvian Nuevo Sol (PEN). """ - PKR + PEN """ Papua New Guinean Kina (PGK). """ PGK - """ - Paraguayan Guarani (PYG). - """ - PYG - - """ - Peruvian Nuevo Sol (PEN). - """ - PEN - """ Philippine Peso (PHP). """ PHP + """ + Pakistani Rupee (PKR). + """ + PKR + """ Polish Zlotych (PLN). """ PLN + """ + Paraguayan Guarani (PYG). + """ + PYG + """ Qatari Rial (QAR). """ @@ -3979,6 +4671,11 @@ enum CurrencyCode { """ RON + """ + Serbian dinar (RSD). + """ + RSD + """ Russian Rubles (RUB). """ @@ -3989,80 +4686,25 @@ enum CurrencyCode { """ RWF - """ - Samoan Tala (WST). - """ - WST - """ Saudi Riyal (SAR). """ SAR - """ - Sao Tome And Principe Dobra (STD). - """ - STD - - """ - Serbian dinar (RSD). - """ - RSD - - """ - Seychellois Rupee (SCR). - """ - SCR - - """ - Singapore Dollars (SGD). - """ - SGD - - """ - Sudanese Pound (SDG). - """ - SDG - - """ - Syrian Pound (SYP). - """ - SYP - - """ - South African Rand (ZAR). - """ - ZAR - - """ - South Korean Won (KRW). - """ - KRW - - """ - South Sudanese Pound (SSP). - """ - SSP - """ Solomon Islands Dollar (SBD). """ SBD """ - Sri Lankan Rupees (LKR). + Seychellois Rupee (SCR). """ - LKR + SCR """ - Surinamese Dollar (SRD). + Sudanese Pound (SDG). """ - SRD - - """ - Swazi Lilangeni (SZL). - """ - SZL + SDG """ Swedish Kronor (SEK). @@ -4070,14 +4712,57 @@ enum CurrencyCode { SEK """ - Swiss Francs (CHF). + Singapore Dollars (SGD). """ - CHF + SGD """ - Taiwan Dollars (TWD). + Saint Helena Pounds (SHP). """ - TWD + SHP + + """ + Sierra Leonean Leone (SLL). + """ + SLL + + """ + Somali Shilling (SOS). + """ + SOS + + """ + Surinamese Dollar (SRD). + """ + SRD + + """ + South Sudanese Pound (SSP). + """ + SSP + + """ + Sao Tome And Principe Dobra (STD). + """ + STD + @deprecated( + reason: "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead." + ) + + """ + Sao Tome And Principe Dobra (STN). + """ + STN + + """ + Syrian Pound (SYP). + """ + SYP + + """ + Swazi Lilangeni (SZL). + """ + SZL """ Thai baht (THB). @@ -4085,24 +4770,9 @@ enum CurrencyCode { THB """ - Tanzanian Shilling (TZS). + Tajikistani Somoni (TJS). """ - TZS - - """ - Trinidad and Tobago Dollars (TTD). - """ - TTD - - """ - Tunisian Dinar (TND). - """ - TND - - """ - Turkish Lira (TRY). - """ - TRY + TJS """ Turkmenistani Manat (TMT). @@ -4110,9 +4780,34 @@ enum CurrencyCode { TMT """ - Ugandan Shilling (UGX). + Tunisian Dinar (TND). """ - UGX + TND + + """ + Tongan Pa'anga (TOP). + """ + TOP + + """ + Turkish Lira (TRY). + """ + TRY + + """ + Trinidad and Tobago Dollars (TTD). + """ + TTD + + """ + Taiwan Dollars (TWD). + """ + TWD + + """ + Tanzanian Shilling (TZS). + """ + TZS """ Ukrainian Hryvnia (UAH). @@ -4120,9 +4815,14 @@ enum CurrencyCode { UAH """ - United Arab Emirates Dirham (AED). + Ugandan Shilling (UGX). """ - AED + UGX + + """ + United States Dollars (USD). + """ + USD """ Uruguayan Pesos (UYU). @@ -4135,125 +4835,83 @@ enum CurrencyCode { UZS """ - Vanuatu Vatu (VUV). + Venezuelan Bolivares (VED). """ - VUV + VED + + """ + Venezuelan Bolivares (VEF). + """ + VEF + @deprecated( + reason: "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead." + ) + + """ + Venezuelan Bolivares (VES). + """ + VES """ Vietnamese đồng (VND). """ VND + """ + Vanuatu Vatu (VUV). + """ + VUV + + """ + Samoan Tala (WST). + """ + WST + + """ + Central African CFA Franc (XAF). + """ + XAF + + """ + East Caribbean Dollar (XCD). + """ + XCD + """ West African CFA franc (XOF). """ XOF + """ + CFP Franc (XPF). + """ + XPF + + """ + Unrecognized currency. + """ + XXX + """ Yemeni Rial (YER). """ YER + """ + South African Rand (ZAR). + """ + ZAR + """ Zambian Kwacha (ZMW). """ ZMW - - """ - Belarusian Ruble (BYN). - """ - BYN - - """ - Belarusian Ruble (BYR). - """ - BYR - - """ - Djiboutian Franc (DJF). - """ - DJF - - """ - Eritrean Nakfa (ERN). - """ - ERN - - """ - Falkland Islands Pounds (FKP). - """ - FKP - - """ - Gibraltar Pounds (GIP). - """ - GIP - - """ - Guinean Franc (GNF). - """ - GNF - - """ - Iranian Rial (IRR). - """ - IRR - - """ - Kiribati Dollar (KID). - """ - KID - - """ - Libyan Dinar (LYD). - """ - LYD - - """ - Mauritanian Ouguiya (MRU). - """ - MRU - - """ - Sierra Leonean Leone (SLL). - """ - SLL - - """ - Saint Helena Pounds (SHP). - """ - SHP - - """ - Somali Shilling (SOS). - """ - SOS - - """ - Tajikistani Somoni (TJS). - """ - TJS - - """ - Tongan Pa'anga (TOP). - """ - TOP - - """ - Venezuelan Bolivares (VEF). - """ - VEF - - """ - Venezuelan Bolivares (VES). - """ - VES } """ A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. """ -type Customer { +type Customer implements HasMetafields { """ Indicates whether the customer has consented to be sent marketing material via email. """ @@ -4263,26 +4921,26 @@ type Customer { A list of addresses for the customer. """ addresses( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -4329,29 +4987,55 @@ type Customer { """ lastName: String + """ + Returns a metafield found by namespace and key. + """ + metafield( + """ + The identifier for the metafield. + """ + key: String! + + """ + A container for a set of metafields. + """ + namespace: String! + ): Metafield + + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( + """ + The list of metafields to retrieve by namespace and key. + """ + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! + """ The orders associated with the customer. """ orders( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `processed_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -4362,15 +5046,6 @@ type Customer { Sort the underlying list by the given key. """ sortKey: OrderSortKeys = ID - - """ - Supported filter parameters: - - `processed_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): OrderConnection! """ @@ -4378,10 +5053,7 @@ type Customer { """ phone: String - """ - A comma separated list of tags that have been added to the customer. - Additional access scope required: unauthenticated_read_customer_tags. - """ + "A comma separated list of tags that have been added to the customer.\nAdditional access scope required: unauthenticated_read_customer_tags.\n" tags: [String!]! """ @@ -4430,15 +5102,15 @@ type CustomerAccessTokenCreatePayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4451,7 +5123,7 @@ type CustomerAccessTokenCreateWithMultipassPayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! } @@ -4471,7 +5143,7 @@ type CustomerAccessTokenDeletePayload { deletedCustomerAccessTokenId: String """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! } @@ -4486,7 +5158,7 @@ type CustomerAccessTokenRenewPayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! } @@ -4506,7 +5178,7 @@ type CustomerActivateByUrlPayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! } @@ -4541,15 +5213,15 @@ type CustomerActivatePayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4562,15 +5234,15 @@ type CustomerAddressCreatePayload { customerAddress: MailingAddress """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4578,7 +5250,7 @@ Return type for `customerAddressDelete` mutation. """ type CustomerAddressDeletePayload { """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! @@ -4588,10 +5260,10 @@ type CustomerAddressDeletePayload { deletedCustomerAddressId: String """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4604,21 +5276,31 @@ type CustomerAddressUpdatePayload { customerAddress: MailingAddress """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ -Specifies the fields required to create a new customer. +The fields required to create a new customer. """ input CustomerCreateInput { + """ + Indicates whether the customer has consented to be sent marketing material via email. + """ + acceptsMarketing: Boolean + + """ + The customer’s email. + """ + email: String! + """ The customer’s first name. """ @@ -4629,27 +5311,13 @@ input CustomerCreateInput { """ lastName: String - """ - The customer’s email. - """ - email: String! - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ - phone: String - """ The login password used by the customer. """ password: String! - """ - Indicates whether the customer has consented to be sent marketing material via email. - """ - acceptsMarketing: Boolean + "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n" + phone: String } """ @@ -4662,15 +5330,15 @@ type CustomerCreatePayload { customer: Customer """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4683,61 +5351,36 @@ type CustomerDefaultAddressUpdatePayload { customer: Customer """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ -Possible error codes that could be returned by CustomerUserError. +Possible error codes that can be returned by `CustomerUserError`. """ enum CustomerErrorCode { """ - Input value is blank. + Customer already enabled. + """ + ALREADY_ENABLED + + """ + Input email contains an invalid domain name. + """ + BAD_DOMAIN + + """ + The input value is blank. """ BLANK - """ - Input value is invalid. - """ - INVALID - - """ - Input value is already taken. - """ - TAKEN - - """ - Input value is too long. - """ - TOO_LONG - - """ - Input value is too short. - """ - TOO_SHORT - - """ - Unidentified customer. - """ - UNIDENTIFIED_CUSTOMER - - """ - Customer is disabled. - """ - CUSTOMER_DISABLED - - """ - Input password starts or ends with whitespace. - """ - PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE - """ Input contains HTML tags. """ @@ -4749,14 +5392,19 @@ enum CustomerErrorCode { CONTAINS_URL """ - Invalid activation token. + Customer is disabled. """ - TOKEN_INVALID + CUSTOMER_DISABLED """ - Customer already enabled. + The input value is invalid. """ - ALREADY_ENABLED + INVALID + + """ + Multipass token is not valid. + """ + INVALID_MULTIPASS_REQUEST """ Address does not exist. @@ -4764,14 +5412,34 @@ enum CustomerErrorCode { NOT_FOUND """ - Input email contains an invalid domain name. + Input password starts or ends with whitespace. """ - BAD_DOMAIN + PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE """ - Multipass token is not valid. + The input value is already taken. """ - INVALID_MULTIPASS_REQUEST + TAKEN + + """ + Invalid activation token. + """ + TOKEN_INVALID + + """ + The input value is too long. + """ + TOO_LONG + + """ + The input value is too short. + """ + TOO_SHORT + + """ + Unidentified customer. + """ + UNIDENTIFIED_CUSTOMER } """ @@ -4779,15 +5447,15 @@ Return type for `customerRecover` mutation. """ type CustomerRecoverPayload { """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4805,30 +5473,30 @@ type CustomerResetByUrlPayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ Specifies the fields required to reset a customer’s password. """ input CustomerResetInput { - """ - The reset token required to reset the customer’s password. - """ - resetToken: String! - """ New password that will be set as part of the reset password process. """ password: String! + + """ + The reset token required to reset the customer’s password. + """ + resetToken: String! } """ @@ -4846,21 +5514,31 @@ type CustomerResetPayload { customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ Specifies the fields required to update the Customer information. """ input CustomerUpdateInput { + """ + Indicates whether the customer has consented to be sent marketing material via email. + """ + acceptsMarketing: Boolean + + """ + The customer’s email. + """ + email: String + """ The customer’s first name. """ @@ -4871,27 +5549,13 @@ input CustomerUpdateInput { """ lastName: String - """ - The customer’s email. - """ - email: String - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. - """ - phone: String - """ The login password used by the customer. """ password: String - """ - Indicates whether the customer has consented to be sent marketing material via email. - """ - acceptsMarketing: Boolean + "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`.\n" + phone: String } """ @@ -4903,22 +5567,19 @@ type CustomerUpdatePayload { """ customer: Customer - """ - The newly created customer access token. If the customer's password is updated, all previous access tokens - (including the one used to perform this mutation) become invalid, and a new token is generated. - """ + "The newly created customer access token. If the customer's password is updated, all previous access tokens\n(including the one used to perform this mutation) become invalid, and a new token is generated.\n" customerAccessToken: CustomerAccessToken """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ customerUserErrors: [CustomerUserError!]! """ - List of errors that occurred executing the mutation. + The list of errors that occurred from executing the mutation. """ userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") + @deprecated(reason: "Use `customerUserErrors` instead.") } """ @@ -4926,12 +5587,12 @@ Represents an error that happens during execution of a customer mutation. """ type CustomerUserError implements DisplayableError { """ - Error code to uniquely identify the error. + The error code. """ code: CustomerErrorCode """ - Path to the input field which caused the error. + The path to the input field that caused the error. """ field: [String!] @@ -4941,30 +5602,61 @@ type CustomerUserError implements DisplayableError { message: String! } -""" -An ISO-8601 encoded UTC date time string. Example value: `"2019-07-03T20:47:55Z"`. -""" +"Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.\nFor example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is\nrepresented as `\"2019-09-07T15:50:00Z`\".\n" scalar DateTime -""" -A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `"29.99"`. -""" +"A signed decimal number, which supports arbitrary precision and is serialized as a string.\n\nExample values: `\"29.99\"`, `\"29.999\"`.\n" scalar Decimal +""" +List of different delivery method types. +""" +enum DeliveryMethodType { + """ + Local Delivery. + """ + LOCAL + + """ + None. + """ + NONE + + """ + Shipping to a Pickup Point. + """ + PICKUP_POINT + + """ + Local Pickup. + """ + PICK_UP + + """ + Retail. + """ + RETAIL + + """ + Shipping. + """ + SHIPPING +} + """ Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. """ enum DigitalWallet { - """ - Apple Pay. - """ - APPLE_PAY - """ Android Pay. """ ANDROID_PAY + """ + Apple Pay. + """ + APPLE_PAY + """ Google Pay. """ @@ -4976,9 +5668,7 @@ enum DigitalWallet { SHOPIFY_PAY } -""" -An amount discounting the line that has been allocated by a discount. -""" +"An amount discounting the line that has been allocated by a discount.\n" type DiscountAllocation { """ Amount of discount allocated. @@ -4991,10 +5681,7 @@ type DiscountAllocation { discountApplication: DiscountApplication! } -""" -Discount applications capture the intentions of a discount source at -the time of application. -""" +"Discount applications capture the intentions of a discount source at\nthe time of application.\n" interface DiscountApplication { """ The method by which the discount's value is allocated to its entitled items. @@ -5034,27 +5721,28 @@ enum DiscountApplicationAllocationMethod { """ The value is specifically applied onto a particular line. """ - ONE + ONE @deprecated(reason: "Use ACROSS instead.") } -""" -An auto-generated type for paginating through multiple DiscountApplications. -""" +"An auto-generated type for paginating through multiple DiscountApplications.\n" type DiscountApplicationConnection { """ A list of edges. """ edges: [DiscountApplicationEdge!]! + """ + A list of the nodes contained in DiscountApplicationEdge. + """ + nodes: [DiscountApplication!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one DiscountApplication and a cursor during pagination. -""" +"An auto-generated type which holds one DiscountApplication and a cursor during pagination.\n" type DiscountApplicationEdge { """ A cursor for use in pagination. @@ -5067,10 +5755,7 @@ type DiscountApplicationEdge { node: DiscountApplication! } -""" -Which lines on the order that the discount is allocated over, of the type -defined by the Discount Application's target_type. -""" +"The lines on the order to which the discount is applied, of the type defined by\nthe discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of\n`LINE_ITEM`, applies the discount on all line items that are entitled to the discount.\nThe value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines.\n" enum DiscountApplicationTargetSelection { """ The discount is allocated onto all the lines. @@ -5078,7 +5763,7 @@ enum DiscountApplicationTargetSelection { ALL """ - The discount is allocated onto only the lines it is entitled for. + The discount is allocated onto only the lines that it's entitled for. """ ENTITLED @@ -5088,9 +5773,7 @@ enum DiscountApplicationTargetSelection { EXPLICIT } -""" -The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. -""" +"The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.\n" enum DiscountApplicationTargetType { """ The discount applies onto line items. @@ -5103,10 +5786,7 @@ enum DiscountApplicationTargetType { SHIPPING_LINE } -""" -Discount code applications capture the intentions of a discount code at -the time that it is applied. -""" +"Discount code applications capture the intentions of a discount code at\nthe time that it is applied.\n" type DiscountCodeApplication implements DiscountApplication { """ The method by which the discount's value is allocated to its entitled items. @@ -5144,7 +5824,7 @@ Represents an error in the input of a mutation. """ interface DisplayableError { """ - Path to the input field which caused the error. + The path to the input field that caused the error. """ field: [String!] @@ -5177,19 +5857,29 @@ type Domain { """ Represents a video hosted outside of Shopify. """ -type ExternalVideo implements Node & Media { +type ExternalVideo implements Media & Node { """ A word or phrase to share the nature or contents of a media. """ alt: String """ - The URL. + The embed URL of the video for the respective host. """ - embeddedUrl: URL! + embedUrl: URL! """ - Globally unique identifier. + The URL. + """ + embeddedUrl: URL! @deprecated(reason: "Use `originUrl` instead.") + + """ + The host of the external video. + """ + host: MediaHost! + + """ + A globally-unique identifier. """ id: ID! @@ -5198,12 +5888,83 @@ type ExternalVideo implements Node & Media { """ mediaContentType: MediaContentType! + """ + The origin URL of the video on the respective host. + """ + originUrl: URL! + """ The preview image for the media. """ previewImage: Image } +""" +A filter that is supported on the parent field. +""" +type Filter { + """ + A unique identifier. + """ + id: String! + + """ + A human-friendly string for this filter. + """ + label: String! + + """ + An enumeration that denotes the type of data this filter represents. + """ + type: FilterType! + + """ + The list of values for this filter. + """ + values: [FilterValue!]! +} + +"The type of data that the filter group represents.\n\nFor more information, refer to [Filter products in a collection with the Storefront API]\n(https://shopify.dev/api/examples/filter-products).\n" +enum FilterType { + """ + A boolean value. + """ + BOOLEAN + + """ + A list of selectable values. + """ + LIST + + """ + A range of prices. + """ + PRICE_RANGE +} + +""" +A selectable value within a filter. +""" +type FilterValue { + """ + The number of results that match this filter value. + """ + count: Int! + + """ + A unique identifier. + """ + id: String! + + "An input object that can be used to filter by this value on the parent field.\n\nThe value is provided as a helper for building dynamic filtering UI. For example, if you have a list of selected `FilterValue` objects, you can combine their respective `input` values to use in a subsequent query.\n" + input: JSON! + + """ + A human-friendly string for this filter value. + """ + label: String! +} + """ Represents a single fulfillment in an order. """ @@ -5212,26 +5973,26 @@ type Fulfillment { List of the fulfillment's line items. """ fulfillmentLineItems( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -5243,10 +6004,7 @@ type Fulfillment { """ trackingCompany: String - """ - Tracking information associated with the fulfillment, - such as the tracking number and tracking URL. - """ + "Tracking information associated with the fulfillment,\nsuch as the tracking number and tracking URL.\n" trackingInfo( """ Truncate the array result to this size. @@ -5270,24 +6028,25 @@ type FulfillmentLineItem { quantity: Int! } -""" -An auto-generated type for paginating through multiple FulfillmentLineItems. -""" +"An auto-generated type for paginating through multiple FulfillmentLineItems.\n" type FulfillmentLineItemConnection { """ A list of edges. """ edges: [FulfillmentLineItemEdge!]! + """ + A list of the nodes contained in FulfillmentLineItemEdge. + """ + nodes: [FulfillmentLineItem!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. -""" +"An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination.\n" type FulfillmentLineItemEdge { """ A cursor for use in pagination. @@ -5316,8 +6075,56 @@ type FulfillmentTrackingInfo { } """ -A string containing HTML code. Example value: `"

Grey cotton knit sweater.

"`. +The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. """ +type GenericFile implements Node { + """ + A word or phrase to indicate the contents of a file. + """ + alt: String + + """ + A globally-unique identifier. + """ + id: ID! + + """ + The MIME type of the file. + """ + mimeType: String + + """ + The size of the original file in bytes. + """ + originalFileSize: Int + + """ + The preview image for the file. + """ + previewImage: Image + + """ + The URL of the file. + """ + url: URL +} + +""" +Used to specify a geographical location. +""" +input GeoCoordinateInput { + """ + The coordinate's latitude value. + """ + latitude: Float! + + """ + The coordinate's longitude value. + """ + longitude: Float! +} + +"A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a\ncomplete list of HTML elements.\n\nExample value: `\"

Grey cotton knit sweater.

\"`.\n" scalar HTML """ @@ -5325,54 +6132,42 @@ Represents information about the metafields associated to the specified resource """ interface HasMetafields { """ - The metafield associated with the resource. + Returns a metafield found by namespace and key. """ metafield( """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). + The identifier for the metafield. """ key: String! + + """ + A container for a set of metafields. + """ + namespace: String! ): Metafield - """ - A paginated list of metafields associated with the resource. - """ + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" metafields( """ - Container for a set of metafields (maximum of 20 characters). + The list of metafields to retrieve by namespace and key. """ - namespace: String + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! +} - """ - Returns up to the first `n` elements from the list. - """ - first: Int +""" +Identifies a metafield on an owner resource by namespace and key. +""" +input HasMetafieldsIdentifier { + """ + The identifier for the metafield. + """ + key: String! - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! + """ + A container for a set of metafields. + """ + namespace: String! } """ @@ -5394,32 +6189,20 @@ type Image { """ id: ID - """ - The location of the original image as a URL. - - If there are any existing transformations in the original source URL, they will remain and not be stripped. - """ - originalSrc: URL! + "The location of the original image as a URL.\n\nIf there are any existing transformations in the original source URL, they will remain and not be stripped.\n" + originalSrc: URL! @deprecated(reason: "Use `url` instead.") """ The location of the image as a URL. """ - src: URL! - @deprecated( - reason: "Previously an image had a single `src` field. This could either return the original image\nlocation or a URL that contained transformations such as sizing or scale.\n\nThese transformations were specified by arguments on the parent field.\n\nNow an image has two distinct URL fields: `originalSrc` and `transformedSrc`.\n\n* `originalSrc` - the original unmodified image URL\n* `transformedSrc` - the image URL with the specified transformations included\n\nTo migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`.\n\nBefore:\n```graphql\n{\n shop {\n productImages(maxWidth: 200, scale: 2) {\n edges {\n node {\n src\n }\n }\n }\n }\n}\n```\n\nAfter:\n```graphql\n{\n shop {\n productImages {\n edges {\n node {\n transformedSrc(maxWidth: 200, scale: 2)\n }\n }\n }\n }\n}\n```\n" - ) + src: URL! @deprecated(reason: "Use `url` instead.") - """ - The location of the transformed image as a URL. - - All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. - Otherwise any transformations which an image type does not support will be ignored. - """ + "The location of the transformed image as a URL.\n\nAll transformation arguments are considered \"best-effort\". If they can be applied to an image, they will be.\nOtherwise any transformations which an image type does not support will be ignored.\n" transformedSrc( """ - Image width in pixels between 1 and 5760. + Crops the image according to the specified region. """ - maxWidth: Int + crop: CropRegion """ Image height in pixels between 1 and 5760. @@ -5427,19 +6210,27 @@ type Image { maxHeight: Int """ - Crops the image according to the specified region. + Image width in pixels between 1 and 5760. """ - crop: CropRegion + maxWidth: Int + + """ + Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported). + """ + preferredContentType: ImageContentType """ Image size multiplier for high-resolution retina displays. Must be between 1 and 3. """ scale: Int = 1 + ): URL! @deprecated(reason: "Use `url(transform:)` instead") + "The location of the image as a URL.\n\nIf no transform options are specified, then the original image will be preserved including any pre-applied transforms.\n\nAll transformation options are considered \"best-effort\". Any transformation that the original image type doesn't support will be ignored.\n\nIf you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).\n" + url( """ - Best effort conversion of image into content type (SVG -> PNG, Anything -> JGP, Anything -> WEBP are supported). + A set of options to transform the original image. """ - preferredContentType: ImageContentType + transform: ImageTransformInput ): URL! """ @@ -5448,15 +6239,18 @@ type Image { width: Int } -""" -An auto-generated type for paginating through multiple Images. -""" +"An auto-generated type for paginating through multiple Images.\n" type ImageConnection { """ A list of edges. """ edges: [ImageEdge!]! + """ + A list of the nodes contained in ImageEdge. + """ + nodes: [Image!]! + """ Information to aid in pagination. """ @@ -5467,25 +6261,23 @@ type ImageConnection { List of supported image content types. """ enum ImageContentType { - """ - A PNG image. - """ - PNG - """ A JPG image. """ JPG + """ + A PNG image. + """ + PNG + """ A WEBP image. """ WEBP } -""" -An auto-generated type which holds one Image and a cursor during pagination. -""" +"An auto-generated type which holds one Image and a cursor during pagination.\n" type ImageEdge { """ A cursor for use in pagination. @@ -5498,6 +6290,899 @@ type ImageEdge { node: Image! } +"The available options for transforming an image.\n\nAll transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored.\n" +input ImageTransformInput { + "The region of the image to remain after cropping.\nMust be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal.\nThe `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while\na smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result\nin an image with a width of 5 and height of 10, where the right side of the image is removed.\n" + crop: CropRegion + + "Image height in pixels between 1 and 5760.\n" + maxHeight: Int + + "Image width in pixels between 1 and 5760.\n" + maxWidth: Int + + "Convert the source image into the preferred content type.\nSupported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`.\n" + preferredContentType: ImageContentType + + "Image size multiplier for high-resolution retina displays. Must be within 1..3.\n" + scale: Int = 1 +} + +"A [JSON](https://www.json.org/json-en.html) object.\n\nExample value:\n`{\n \"product\": {\n \"id\": \"gid://shopify/Product/1346443542550\",\n \"title\": \"White T-shirt\",\n \"options\": [{\n \"name\": \"Size\",\n \"values\": [\"M\", \"L\"]\n }]\n }\n}`\n" +scalar JSON + +""" +A language. +""" +type Language { + """ + The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. + """ + endonymName: String! + + """ + The ISO code. + """ + isoCode: LanguageCode! + + """ + The name of the language in the current language. + """ + name: String! +} + +""" +ISO 639-1 language codes supported by Shopify. +""" +enum LanguageCode { + """ + Afrikaans. + """ + AF + + """ + Akan. + """ + AK + + """ + Amharic. + """ + AM + + """ + Arabic. + """ + AR + + """ + Assamese. + """ + AS + + """ + Azerbaijani. + """ + AZ + + """ + Belarusian. + """ + BE + + """ + Bulgarian. + """ + BG + + """ + Bambara. + """ + BM + + """ + Bangla. + """ + BN + + """ + Tibetan. + """ + BO + + """ + Breton. + """ + BR + + """ + Bosnian. + """ + BS + + """ + Catalan. + """ + CA + + """ + Chechen. + """ + CE + + """ + Czech. + """ + CS + + """ + Church Slavic. + """ + CU + + """ + Welsh. + """ + CY + + """ + Danish. + """ + DA + + """ + German. + """ + DE + + """ + Dzongkha. + """ + DZ + + """ + Ewe. + """ + EE + + """ + Greek. + """ + EL + + """ + English. + """ + EN + + """ + Esperanto. + """ + EO + + """ + Spanish. + """ + ES + + """ + Estonian. + """ + ET + + """ + Basque. + """ + EU + + """ + Persian. + """ + FA + + """ + Fulah. + """ + FF + + """ + Finnish. + """ + FI + + """ + Faroese. + """ + FO + + """ + French. + """ + FR + + """ + Western Frisian. + """ + FY + + """ + Irish. + """ + GA + + """ + Scottish Gaelic. + """ + GD + + """ + Galician. + """ + GL + + """ + Gujarati. + """ + GU + + """ + Manx. + """ + GV + + """ + Hausa. + """ + HA + + """ + Hebrew. + """ + HE + + """ + Hindi. + """ + HI + + """ + Croatian. + """ + HR + + """ + Hungarian. + """ + HU + + """ + Armenian. + """ + HY + + """ + Interlingua. + """ + IA + + """ + Indonesian. + """ + ID + + """ + Igbo. + """ + IG + + """ + Sichuan Yi. + """ + II + + """ + Icelandic. + """ + IS + + """ + Italian. + """ + IT + + """ + Japanese. + """ + JA + + """ + Javanese. + """ + JV + + """ + Georgian. + """ + KA + + """ + Kikuyu. + """ + KI + + """ + Kazakh. + """ + KK + + """ + Kalaallisut. + """ + KL + + """ + Khmer. + """ + KM + + """ + Kannada. + """ + KN + + """ + Korean. + """ + KO + + """ + Kashmiri. + """ + KS + + """ + Kurdish. + """ + KU + + """ + Cornish. + """ + KW + + """ + Kyrgyz. + """ + KY + + """ + Luxembourgish. + """ + LB + + """ + Ganda. + """ + LG + + """ + Lingala. + """ + LN + + """ + Lao. + """ + LO + + """ + Lithuanian. + """ + LT + + """ + Luba-Katanga. + """ + LU + + """ + Latvian. + """ + LV + + """ + Malagasy. + """ + MG + + """ + Māori. + """ + MI + + """ + Macedonian. + """ + MK + + """ + Malayalam. + """ + ML + + """ + Mongolian. + """ + MN + + """ + Marathi. + """ + MR + + """ + Malay. + """ + MS + + """ + Maltese. + """ + MT + + """ + Burmese. + """ + MY + + """ + Norwegian (Bokmål). + """ + NB + + """ + North Ndebele. + """ + ND + + """ + Nepali. + """ + NE + + """ + Dutch. + """ + NL + + """ + Norwegian Nynorsk. + """ + NN + + """ + Norwegian. + """ + NO + + """ + Oromo. + """ + OM + + """ + Odia. + """ + OR + + """ + Ossetic. + """ + OS + + """ + Punjabi. + """ + PA + + """ + Polish. + """ + PL + + """ + Pashto. + """ + PS + + """ + Portuguese. + """ + PT + + """ + Portuguese (Brazil). + """ + PT_BR + + """ + Portuguese (Portugal). + """ + PT_PT + + """ + Quechua. + """ + QU + + """ + Romansh. + """ + RM + + """ + Rundi. + """ + RN + + """ + Romanian. + """ + RO + + """ + Russian. + """ + RU + + """ + Kinyarwanda. + """ + RW + + """ + Sindhi. + """ + SD + + """ + Northern Sami. + """ + SE + + """ + Sango. + """ + SG + + """ + Sinhala. + """ + SI + + """ + Slovak. + """ + SK + + """ + Slovenian. + """ + SL + + """ + Shona. + """ + SN + + """ + Somali. + """ + SO + + """ + Albanian. + """ + SQ + + """ + Serbian. + """ + SR + + """ + Sundanese. + """ + SU + + """ + Swedish. + """ + SV + + """ + Swahili. + """ + SW + + """ + Tamil. + """ + TA + + """ + Telugu. + """ + TE + + """ + Tajik. + """ + TG + + """ + Thai. + """ + TH + + """ + Tigrinya. + """ + TI + + """ + Turkmen. + """ + TK + + """ + Tongan. + """ + TO + + """ + Turkish. + """ + TR + + """ + Tatar. + """ + TT + + """ + Uyghur. + """ + UG + + """ + Ukrainian. + """ + UK + + """ + Urdu. + """ + UR + + """ + Uzbek. + """ + UZ + + """ + Vietnamese. + """ + VI + + """ + Volapük. + """ + VO + + """ + Wolof. + """ + WO + + """ + Xhosa. + """ + XH + + """ + Yiddish. + """ + YI + + """ + Yoruba. + """ + YO + + """ + Chinese. + """ + ZH + + """ + Chinese (Simplified). + """ + ZH_CN + + """ + Chinese (Traditional). + """ + ZH_TW + + """ + Zulu. + """ + ZU +} + +""" +Information about the localized experiences configured for the shop. +""" +type Localization { + """ + The list of countries with enabled localized experiences. + """ + availableCountries: [Country!]! + + """ + The list of languages available for the active country. + """ + availableLanguages: [Language!]! + + """ + The country of the active localized experience. Use the `@inContext` directive to change this value. + """ + country: Country! + + """ + The language of the active localized experience. Use the `@inContext` directive to change this value. + """ + language: Language! +} + +""" +Represents a location where product inventory is held. +""" +type Location implements Node { + """ + The address of the location. + """ + address: LocationAddress! + + """ + A globally-unique identifier. + """ + id: ID! + + """ + The name of the location. + """ + name: String! +} + +"Represents the address of a location.\n" +type LocationAddress { + """ + The first line of the address for the location. + """ + address1: String + + """ + The second line of the address for the location. + """ + address2: String + + """ + The city of the location. + """ + city: String + + """ + The country of the location. + """ + country: String + + """ + The country code of the location. + """ + countryCode: String + + """ + A formatted version of the address for the location. + """ + formatted: [String!]! + + """ + The latitude coordinates of the location. + """ + latitude: Float + + """ + The longitude coordinates of the location. + """ + longitude: Float + + """ + The phone number of the location. + """ + phone: String + + """ + The province of the location. + """ + province: String + + "The code for the province, state, or district of the address of the location.\n" + provinceCode: String + + """ + The ZIP code of the location. + """ + zip: String +} + +"An auto-generated type for paginating through multiple Locations.\n" +type LocationConnection { + """ + A list of edges. + """ + edges: [LocationEdge!]! + + """ + A list of the nodes contained in LocationEdge. + """ + nodes: [Location!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one Location and a cursor during pagination.\n" +type LocationEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of LocationEdge. + """ + node: Location! +} + +""" +The set of valid sort keys for the Location query. +""" +enum LocationSortKeys { + """ + Sort by the `city` value. + """ + CITY + + """ + Sort by the `distance` value. + """ + DISTANCE + + """ + Sort by the `id` value. + """ + ID + + """ + Sort by the `name` value. + """ + NAME +} + """ Represents a mailing address for customers and shipping. """ @@ -5507,38 +7192,22 @@ type MailingAddress implements Node { """ address1: String - """ - The second line of the address. Typically the number of the apartment, suite, or unit. - """ + "The second line of the address. Typically the number of the apartment, suite, or unit.\n" address2: String - """ - The name of the city, district, village, or town. - """ + "The name of the city, district, village, or town.\n" city: String - """ - The name of the customer's company or organization. - """ + "The name of the customer's company or organization.\n" company: String - """ - The name of the country. - """ + "The name of the country.\n" country: String - """ - The two-letter code for the country of the address. + "The two-letter code for the country of the address.\n\nFor example, US.\n" + countryCode: String @deprecated(reason: "Use `countryCodeV2` instead.") - For example, US. - """ - countryCode: String @deprecated(reason: "Use `countryCodeV2` instead") - - """ - The two-letter code for the country of the address. - - For example, US. - """ + "The two-letter code for the country of the address.\n\nFor example, US.\n" countryCodeV2: CountryCode """ @@ -5550,15 +7219,15 @@ type MailingAddress implements Node { A formatted version of the address, customized by the provided arguments. """ formatted( - """ - Whether to include the customer's name in the formatted address. - """ - withName: Boolean = false - """ Whether to include the customer's company in the formatted address. """ withCompany: Boolean = true + + """ + Whether to include the customer's name in the formatted address. + """ + withName: Boolean = false ): [String!]! """ @@ -5567,7 +7236,7 @@ type MailingAddress implements Node { formattedArea: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -5586,16 +7255,10 @@ type MailingAddress implements Node { """ longitude: Float - """ - The full name of the customer, based on firstName and lastName. - """ + "The full name of the customer, based on firstName and lastName.\n" name: String - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ + "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n" phone: String """ @@ -5603,11 +7266,7 @@ type MailingAddress implements Node { """ province: String - """ - The two-letter code for the region. - - For example, ON. - """ + "The two-letter code for the region.\n\nFor example, ON.\n" provinceCode: String """ @@ -5616,24 +7275,25 @@ type MailingAddress implements Node { zip: String } -""" -An auto-generated type for paginating through multiple MailingAddresses. -""" +"An auto-generated type for paginating through multiple MailingAddresses.\n" type MailingAddressConnection { """ A list of edges. """ edges: [MailingAddressEdge!]! + """ + A list of the nodes contained in MailingAddressEdge. + """ + nodes: [MailingAddress!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one MailingAddress and a cursor during pagination. -""" +"An auto-generated type which holds one MailingAddress and a cursor during pagination.\n" type MailingAddressEdge { """ A cursor for use in pagination. @@ -5650,24 +7310,16 @@ type MailingAddressEdge { Specifies the fields accepted to create or update a mailing address. """ input MailingAddressInput { - """ - The first line of the address. Typically the street address or PO Box number. - """ + "The first line of the address. Typically the street address or PO Box number.\n" address1: String - """ - The second line of the address. Typically the number of the apartment, suite, or unit. - """ + "The second line of the address. Typically the number of the apartment, suite, or unit.\n" address2: String - """ - The name of the city, district, village, or town. - """ + "The name of the city, district, village, or town.\n" city: String - """ - The name of the customer's company or organization. - """ + "The name of the customer's company or organization.\n" company: String """ @@ -5685,11 +7337,7 @@ input MailingAddressInput { """ lastName: String - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ + "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n" phone: String """ @@ -5703,9 +7351,7 @@ input MailingAddressInput { zip: String } -""" -Manual discount applications capture the intentions of a discount that was manually created. -""" +"Manual discount applications capture the intentions of a discount that was manually created.\n" type ManualDiscountApplication implements DiscountApplication { """ The method by which the discount's value is allocated to its entitled items. @@ -5758,15 +7404,18 @@ interface Media { previewImage: Image } -""" -An auto-generated type for paginating through multiple Media. -""" +"An auto-generated type for paginating through multiple Media.\n" type MediaConnection { """ A list of edges. """ edges: [MediaEdge!]! + """ + A list of the nodes contained in MediaEdge. + """ + nodes: [Media!]! + """ Information to aid in pagination. """ @@ -5798,9 +7447,7 @@ enum MediaContentType { VIDEO } -""" -An auto-generated type which holds one Media and a cursor during pagination. -""" +"An auto-generated type which holds one Media and a cursor during pagination.\n" type MediaEdge { """ A cursor for use in pagination. @@ -5813,17 +7460,32 @@ type MediaEdge { node: Media! } +""" +Host for a Media Resource. +""" +enum MediaHost { + """ + Host for Vimeo embedded videos. + """ + VIMEO + + """ + Host for YouTube embedded videos. + """ + YOUTUBE +} + """ Represents a Shopify hosted image. """ -type MediaImage implements Node & Media { +type MediaImage implements Media & Node { """ A word or phrase to share the nature or contents of a media. """ alt: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -5843,10 +7505,138 @@ type MediaImage implements Node & Media { previewImage: Image } +"A menu used for navigation within a storefront.\n" +type Menu implements Node { + """ + The menu's handle. + """ + handle: String! + + """ + A globally-unique identifier. + """ + id: ID! + + """ + The menu's child items. + """ + items: [MenuItem!]! + + """ + The count of items on the menu. + """ + itemsCount: Int! + + """ + The menu's title. + """ + title: String! +} + +"A menu item within a parent menu.\n" +type MenuItem implements Node { + """ + A globally-unique identifier. + """ + id: ID! + + """ + The menu item's child items. + """ + items: [MenuItem!]! + + """ + The ID of the linked resource. + """ + resourceId: ID + + """ + The menu item's tags to filter a collection. + """ + tags: [String!]! + + """ + The menu item's title. + """ + title: String! + + """ + The menu item's type. + """ + type: MenuItemType! + + """ + The menu item's URL. + """ + url: URL +} + """ -Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are -comprised of keys, values, and value types. +A menu item type. """ +enum MenuItemType { + """ + An article link. + """ + ARTICLE + + """ + A blog link. + """ + BLOG + + """ + A catalog link. + """ + CATALOG + + """ + A collection link. + """ + COLLECTION + + """ + A collection link. + """ + COLLECTIONS + + """ + A frontpage link. + """ + FRONTPAGE + + """ + An http link. + """ + HTTP + + """ + A page link. + """ + PAGE + + """ + A product link. + """ + PRODUCT + + """ + A search link. + """ + SEARCH + + """ + A shop policy link. + """ + SHOP_POLICY +} + +""" +The merchandise to be purchased at checkout. +""" +union Merchandise = ProductVariant + +"Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are\ncomprised of keys, values, and value types.\n" type Metafield implements Node { """ The date and time when the storefront metafield was created. @@ -5859,7 +7649,7 @@ type Metafield implements Node { description: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -5878,6 +7668,14 @@ type Metafield implements Node { """ parentResource: MetafieldParentResource! + """ + Returns a reference object if the metafield definition's type is a resource reference. + """ + reference: MetafieldReference + + "The type name of the metafield.\nSee the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).\n" + type: String! + """ The date and time when the storefront metafield was updated. """ @@ -5887,79 +7685,60 @@ type Metafield implements Node { The value of a metafield. """ value: String! - - """ - Represents the metafield value type. - """ - valueType: MetafieldValueType! } -""" -An auto-generated type for paginating through multiple Metafields. -""" -type MetafieldConnection { +"A filter used to view a subset of products in a collection matching a specific metafield value.\n\nOnly the following metafield types are currently supported:\n- `number_integer`\n- `number_decimal`\n- `single_line_text_field`\n- `boolean` as of 2022-04.\n" +input MetafieldFilter { """ - A list of edges. + The key of the metafield to filter on. """ - edges: [MetafieldEdge!]! + key: String! """ - Information to aid in pagination. + The namespace of the metafield to filter on. """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Metafield and a cursor during pagination. -""" -type MetafieldEdge { - """ - A cursor for use in pagination. - """ - cursor: String! + namespace: String! """ - The item at the end of MetafieldEdge. + The value of the metafield. """ - node: Metafield! + value: String! } """ A resource that the metafield belongs to. """ -union MetafieldParentResource = Product | ProductVariant +union MetafieldParentResource = + Article + | Blog + | Collection + | Customer + | Order + | Page + | Product + | ProductVariant + | Shop -""" -Metafield value types. -""" -enum MetafieldValueType { - """ - A string metafield. - """ - STRING - - """ - An integer metafield. - """ - INTEGER - - """ - A json string metafield. - """ - JSON_STRING -} +"Returns the resource which is being referred to by a metafield.\n" +union MetafieldReference = + GenericFile + | MediaImage + | Page + | Product + | ProductVariant + | Video """ Represents a Shopify hosted 3D model. """ -type Model3d implements Node & Media { +type Model3d implements Media & Node { """ A word or phrase to share the nature or contents of a media. """ alt: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -6005,7 +7784,7 @@ type Model3dSource { } """ -A monetary value string. Example value: `"100.57"`. +A monetary value string without a currency symbol or code. Example value: `"100.57"`. """ scalar Money @@ -6024,29 +7803,7 @@ input MoneyInput { currencyCode: CurrencyCode! } -""" -A monetary value with currency. - -To format currencies, combine this type's amount and currencyCode fields with your client's locale. - -For example, in JavaScript you could use Intl.NumberFormat: - -```js -new Intl.NumberFormat(locale, { - style: 'currency', - currency: currencyCode -}).format(amount); -``` - -Other formatting libraries include: - -* iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter) -* Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html) -* PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php) - -For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations -(such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)). -""" +"A monetary value with currency.\n" type MoneyV2 { """ Decimal money amount. @@ -6059,58 +7816,123 @@ type MoneyV2 { currencyCode: CurrencyCode! } -""" -An auto-generated type for paginating through multiple MoneyV2s. -""" -type MoneyV2Connection { - """ - A list of edges. - """ - edges: [MoneyV2Edge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one MoneyV2 and a cursor during pagination. -""" -type MoneyV2Edge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of MoneyV2Edge. - """ - node: MoneyV2! -} - """ The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. """ type Mutation { """ - Updates the attributes of a checkout. + Updates the attributes on a cart. """ - checkoutAttributesUpdate( + cartAttributesUpdate( """ - The ID of the checkout. + An array of key-value pairs that contains additional information about the cart. """ - checkoutId: ID! + attributes: [AttributeInput!]! """ - The fields used to update a checkout's attributes. + The ID of the cart. """ - input: CheckoutAttributesUpdateInput! - ): CheckoutAttributesUpdatePayload - @deprecated(reason: "Use `checkoutAttributesUpdateV2` instead") + cartId: ID! + ): CartAttributesUpdatePayload + + "Updates customer information associated with a cart.\nBuyer identity is used to determine\n[international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout)\nand should match the customer's shipping address.\n" + cartBuyerIdentityUpdate( + """ + The customer associated with the cart. Used to determine [international pricing](https://shopify.dev/api/examples/international-pricing#create-a-checkout). Buyer identity should match the customer's shipping address. + """ + buyerIdentity: CartBuyerIdentityInput! + + """ + The ID of the cart. + """ + cartId: ID! + ): CartBuyerIdentityUpdatePayload """ - Updates the attributes of a checkout. + Creates a new cart. + """ + cartCreate( + """ + The fields used to create a cart. + """ + input: CartInput + ): CartCreatePayload + + """ + Updates the discount codes applied to the cart. + """ + cartDiscountCodesUpdate( + """ + The ID of the cart. + """ + cartId: ID! + + "The case-insensitive discount codes that the customer added at checkout.\n" + discountCodes: [String!] + ): CartDiscountCodesUpdatePayload + + """ + Adds a merchandise line to the cart. + """ + cartLinesAdd( + """ + The ID of the cart. + """ + cartId: ID! + + """ + A list of merchandise lines to add to the cart. + """ + lines: [CartLineInput!]! + ): CartLinesAddPayload + + """ + Removes one or more merchandise lines from the cart. + """ + cartLinesRemove( + """ + The ID of the cart. + """ + cartId: ID! + + """ + The merchandise line IDs to remove. + """ + lineIds: [ID!]! + ): CartLinesRemovePayload + + """ + Updates one or more merchandise lines on a cart. + """ + cartLinesUpdate( + """ + The ID of the cart. + """ + cartId: ID! + + """ + The merchandise lines to update. + """ + lines: [CartLineUpdateInput!]! + ): CartLinesUpdatePayload + + """ + Updates the note on the cart. + """ + cartNoteUpdate( + """ + The ID of the cart. + """ + cartId: ID! + + """ + The note on the cart. + """ + note: String + ): CartNoteUpdatePayload + + """ + Updates the attributes of a checkout if `allowPartialAddresses` is `true`. """ checkoutAttributesUpdateV2( """ @@ -6135,23 +7957,7 @@ type Mutation { ): CheckoutCompleteFreePayload """ - Completes a checkout using a credit card token from Shopify's Vault. - """ - checkoutCompleteWithCreditCard( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The credit card info to apply as a payment. - """ - payment: CreditCardPaymentInput! - ): CheckoutCompleteWithCreditCardPayload - @deprecated(reason: "Use `checkoutCompleteWithCreditCardV2` instead") - - """ - Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://help.shopify.com/api/guides/sales-channel-sdk/getting-started#request-payment-processing). + Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). """ checkoutCompleteWithCreditCardV2( """ @@ -6165,38 +7971,6 @@ type Mutation { payment: CreditCardPaymentInputV2! ): CheckoutCompleteWithCreditCardV2Payload - """ - Completes a checkout with a tokenized payment. - """ - checkoutCompleteWithTokenizedPayment( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The info to apply as a tokenized payment. - """ - payment: TokenizedPaymentInput! - ): CheckoutCompleteWithTokenizedPaymentPayload - @deprecated(reason: "Use `checkoutCompleteWithTokenizedPaymentV2` instead") - - """ - Completes a checkout with a tokenized payment. - """ - checkoutCompleteWithTokenizedPaymentV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The info to apply as a tokenized payment. - """ - payment: TokenizedPaymentInputV2! - ): CheckoutCompleteWithTokenizedPaymentV2Payload - @deprecated(reason: "Use `checkoutCompleteWithTokenizedPaymentV3` instead") - """ Completes a checkout with a tokenized payment. """ @@ -6220,24 +7994,13 @@ type Mutation { The fields used to create a checkout. """ input: CheckoutCreateInput! + + """ + The checkout queue token. Available only to selected stores. + """ + queueToken: String ): CheckoutCreatePayload - """ - Associates a customer to the checkout. - """ - checkoutCustomerAssociate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The customer access token of the customer to associate. - """ - customerAccessToken: String! - ): CheckoutCustomerAssociatePayload - @deprecated(reason: "Use `checkoutCustomerAssociateV2` instead") - """ Associates a customer to the checkout. """ @@ -6253,17 +8016,6 @@ type Mutation { customerAccessToken: String! ): CheckoutCustomerAssociateV2Payload - """ - Disassociates the current checkout customer from the checkout. - """ - checkoutCustomerDisassociate( - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutCustomerDisassociatePayload - @deprecated(reason: "Use `checkoutCustomerDisassociateV2` instead") - """ Disassociates the current checkout customer from the checkout. """ @@ -6274,39 +8026,23 @@ type Mutation { checkoutId: ID! ): CheckoutCustomerDisassociateV2Payload - """ - Applies a discount to an existing checkout using a discount code. - """ - checkoutDiscountCodeApply( - """ - The discount code to apply to the checkout. - """ - discountCode: String! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutDiscountCodeApplyPayload - @deprecated(reason: "Use `checkoutDiscountCodeApplyV2` instead") - """ Applies a discount to an existing checkout using a discount code. """ checkoutDiscountCodeApplyV2( - """ - The discount code to apply to the checkout. - """ - discountCode: String! - """ The ID of the checkout. """ checkoutId: ID! + + """ + The discount code to apply to the checkout. + """ + discountCode: String! ): CheckoutDiscountCodeApplyV2Payload """ - Removes the applied discount from an existing checkout. + Removes the applied discounts from an existing checkout. """ checkoutDiscountCodeRemove( """ @@ -6315,22 +8051,6 @@ type Mutation { checkoutId: ID! ): CheckoutDiscountCodeRemovePayload - """ - Updates the email on an existing checkout. - """ - checkoutEmailUpdate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The email to update the checkout with. - """ - email: String! - ): CheckoutEmailUpdatePayload - @deprecated(reason: "Use `checkoutEmailUpdateV2` instead") - """ Updates the email on an existing checkout. """ @@ -6346,38 +8066,6 @@ type Mutation { email: String! ): CheckoutEmailUpdateV2Payload - """ - Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards. - """ - checkoutGiftCardApply( - """ - The code of the gift card to apply on the checkout. - """ - giftCardCode: String! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardApplyPayload - @deprecated(reason: "Use `checkoutGiftCardsAppend` instead") - - """ - Removes an applied gift card from the checkout. - """ - checkoutGiftCardRemove( - """ - The ID of the Applied Gift Card to remove from the Checkout. - """ - appliedGiftCardId: ID! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardRemovePayload - @deprecated(reason: "Use `checkoutGiftCardRemoveV2` instead") - """ Removes an applied gift card from the checkout. """ @@ -6397,30 +8085,30 @@ type Mutation { Appends gift cards to an existing checkout. """ checkoutGiftCardsAppend( - """ - A list of gift card codes to append to the checkout. - """ - giftCardCodes: [String!]! - """ The ID of the checkout. """ checkoutId: ID! + + """ + A list of gift card codes to append to the checkout. + """ + giftCardCodes: [String!]! ): CheckoutGiftCardsAppendPayload """ Adds a list of line items to a checkout. """ checkoutLineItemsAdd( - """ - A list of line item objects to add to the checkout. - """ - lineItems: [CheckoutLineItemInput!]! - """ The ID of the checkout. """ checkoutId: ID! + + """ + A list of line item objects to add to the checkout. + """ + lineItems: [CheckoutLineItemInput!]! ): CheckoutLineItemsAddPayload """ @@ -6442,15 +8130,15 @@ type Mutation { Sets a list of line items to a checkout. """ checkoutLineItemsReplace( - """ - A list of line item objects to set on the checkout. - """ - lineItems: [CheckoutLineItemInput!]! - """ The ID of the checkout. """ checkoutId: ID! + + """ + A list of line item objects to set on the checkout. + """ + lineItems: [CheckoutLineItemInput!]! ): CheckoutLineItemsReplacePayload """ @@ -6468,35 +8156,19 @@ type Mutation { lineItems: [CheckoutLineItemUpdateInput!]! ): CheckoutLineItemsUpdatePayload - """ - Updates the shipping address of an existing checkout. - """ - checkoutShippingAddressUpdate( - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutShippingAddressUpdatePayload - @deprecated(reason: "Use `checkoutShippingAddressUpdateV2` instead") - """ Updates the shipping address of an existing checkout. """ checkoutShippingAddressUpdateV2( - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput! - """ The ID of the checkout. """ checkoutId: ID! + + """ + The shipping address to where the line items will be shipped. + """ + shippingAddress: MailingAddressInput! ): CheckoutShippingAddressUpdateV2Payload """ @@ -6514,10 +8186,7 @@ type Mutation { shippingRateHandle: String! ): CheckoutShippingLineUpdatePayload - """ - Creates a customer access token. - The customer access token is required to modify the customer object in any way. - """ + "Creates a customer access token.\nThe customer access token is required to modify the customer object in any way.\n" customerAccessTokenCreate( """ The fields used to create a customer access token. @@ -6525,14 +8194,10 @@ type Mutation { input: CustomerAccessTokenCreateInput! ): CustomerAccessTokenCreatePayload - """ - Creates a customer access token using a multipass token instead of email and password. - A customer record is created if customer does not exist. If a customer record already - exists but the record is disabled, then it's enabled. - """ + "Creates a customer access token using a\n[multipass token](https://shopify.dev/api/multipass) instead of email and\npassword. A customer record is created if the customer doesn't exist. If a customer\nrecord already exists but the record is disabled, then the customer record is enabled.\n" customerAccessTokenCreateWithMultipass( """ - A valid multipass token to be authenticated. + A valid [multipass token](https://shopify.dev/api/multipass) to be authenticated. """ multipassToken: String! ): CustomerAccessTokenCreateWithMultipassPayload @@ -6547,12 +8212,7 @@ type Mutation { customerAccessToken: String! ): CustomerAccessTokenDeletePayload - """ - Renews a customer access token. - - Access token renewal must happen *before* a token expires. - If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. - """ + "Renews a customer access token.\n\nAccess token renewal must happen *before* a token expires.\nIf a token has already expired, a new one should be created instead via `customerAccessTokenCreate`.\n" customerAccessTokenRenew( """ The access token used to identify the customer. @@ -6594,36 +8254,41 @@ type Mutation { Creates a new address for a customer. """ customerAddressCreate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - """ The customer mailing address to create. """ address: MailingAddressInput! + + """ + The access token used to identify the customer. + """ + customerAccessToken: String! ): CustomerAddressCreatePayload """ Permanently deletes the address of an existing customer. """ customerAddressDelete( - """ - Specifies the address to delete. - """ - id: ID! - """ The access token used to identify the customer. """ customerAccessToken: String! + + """ + Specifies the address to delete. + """ + id: ID! ): CustomerAddressDeletePayload """ Updates the address of an existing customer. """ customerAddressUpdate( + """ + The customer’s mailing address. + """ + address: MailingAddressInput! + """ The access token used to identify the customer. """ @@ -6633,11 +8298,6 @@ type Mutation { Specifies the customer address to update. """ id: ID! - - """ - The customer’s mailing address. - """ - address: MailingAddressInput! ): CustomerAddressUpdatePayload """ @@ -6654,20 +8314,18 @@ type Mutation { Updates the default address of an existing customer. """ customerDefaultAddressUpdate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - """ ID of the address to set as the new default for the customer. """ addressId: ID! + + """ + The access token used to identify the customer. + """ + customerAccessToken: String! ): CustomerDefaultAddressUpdatePayload - """ - Sends a reset password email to the customer, as the first step in the reset password process. - """ + "\"Sends a reset password email to the customer. The reset password email contains a reset password URL and token that you can pass to the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the customer password.\"\n" customerRecover( """ The email address of the customer to recover. @@ -6675,9 +8333,7 @@ type Mutation { email: String! ): CustomerRecoverPayload - """ - Resets a customer’s password with a token received from `CustomerRecover`. - """ + "\"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation.\"\n" customerReset( """ Specifies the customer to reset. @@ -6690,51 +8346,57 @@ type Mutation { input: CustomerResetInput! ): CustomerResetPayload - """ - Resets a customer’s password with the reset password url received from `CustomerRecover`. - """ + "\"Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation.\"\n" customerResetByUrl( - """ - The customer's reset password url. - """ - resetUrl: URL! - """ New password that will be set as part of the reset password process. """ password: String! + + """ + The customer's reset password url. + """ + resetUrl: URL! ): CustomerResetByUrlPayload """ Updates an existing customer. """ customerUpdate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - """ The customer object input. """ customer: CustomerUpdateInput! + + """ + The access token used to identify the customer. + """ + customerAccessToken: String! ): CustomerUpdatePayload } -""" -An object with an ID to support global identification. -""" +"An object with an ID field to support global identification, in accordance with the\n[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).\nThis interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)\nand [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.\n" interface Node { """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! } +""" +Represents a resource that can be published to the Online Store sales channel. +""" +interface OnlineStorePublishable { + """ + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. + """ + onlineStoreUrl: URL +} + """ An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. """ -type Order implements Node { +type Order implements HasMetafields & Node { """ The reason for the order's cancellation. Returns `null` if the order wasn't canceled. """ @@ -6755,6 +8417,11 @@ type Order implements Node { """ currentSubtotalPrice: MoneyV2! + """ + The total cost of duties for the order, including refunds. + """ + currentTotalDuties: MoneyV2 + """ The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. """ @@ -6779,26 +8446,26 @@ type Order implements Node { Discounts that have been applied on the order. """ discountApplications( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -6826,7 +8493,7 @@ type Order implements Node { fulfillmentStatus: OrderFulfillmentStatus! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -6834,26 +8501,26 @@ type Order implements Node { List of the order’s line items. """ lineItems( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -6861,9 +8528,29 @@ type Order implements Node { ): OrderLineItemConnection! """ - Unique identifier for the order that appears on the order. - For example, _#1000_ or _Store1001. + Returns a metafield found by namespace and key. """ + metafield( + """ + The identifier for the metafield. + """ + key: String! + + """ + A container for a set of metafields. + """ + namespace: String! + ): Metafield + + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( + """ + The list of metafields to retrieve by namespace and key. + """ + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! + + "Unique identifier for the order that appears on the order.\nFor example, _#1000_ or _Store1001.\n" name: String! """ @@ -6871,6 +8558,11 @@ type Order implements Node { """ orderNumber: Int! + """ + The total cost of duties charged at checkout. + """ + originalTotalDuties: MoneyV2 + """ The total price of the order before any applied edits. """ @@ -6881,11 +8573,7 @@ type Order implements Node { """ phone: String - """ - The date and time when the order was imported. - This value can be set to dates in the past when importing from other systems. - If no value is provided, it will be auto-generated based on current date and time. - """ + "The date and time when the order was imported.\nThis value can be set to dates in the past when importing from other systems.\nIf no value is provided, it will be auto-generated based on current date and time.\n" processedAt: DateTime! """ @@ -6893,9 +8581,7 @@ type Order implements Node { """ shippingAddress: MailingAddress - """ - The discounts that have been allocated onto the shipping line by discount applications. - """ + "The discounts that have been allocated onto the shipping line by discount applications.\n" shippingDiscountAllocations: [DiscountAllocation!]! """ @@ -6906,7 +8592,7 @@ type Order implements Node { """ Price of the order before shipping and taxes. """ - subtotalPrice: Money @deprecated(reason: "Use `subtotalPriceV2` instead") + subtotalPrice: Money @deprecated(reason: "Use `subtotalPriceV2` instead.") """ Price of the order before duties, shipping and taxes. @@ -6926,7 +8612,7 @@ type Order implements Node { """ The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). """ - totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead") + totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead.") """ The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). @@ -6936,7 +8622,7 @@ type Order implements Node { """ The total amount that has been refunded. """ - totalRefunded: Money! @deprecated(reason: "Use `totalRefundedV2` instead") + totalRefunded: Money! @deprecated(reason: "Use `totalRefundedV2` instead.") """ The total amount that has been refunded. @@ -6947,7 +8633,7 @@ type Order implements Node { The total cost of shipping. """ totalShippingPrice: Money! - @deprecated(reason: "Use `totalShippingPriceV2` instead") + @deprecated(reason: "Use `totalShippingPriceV2` instead.") """ The total cost of shipping. @@ -6957,7 +8643,7 @@ type Order implements Node { """ The total cost of taxes. """ - totalTax: Money @deprecated(reason: "Use `totalTaxV2` instead") + totalTax: Money @deprecated(reason: "Use `totalTaxV2` instead.") """ The total cost of taxes. @@ -6974,6 +8660,11 @@ enum OrderCancelReason { """ CUSTOMER + """ + Payment was declined. + """ + DECLINED + """ The order was fraudulent. """ @@ -6984,35 +8675,31 @@ enum OrderCancelReason { """ INVENTORY - """ - Payment was declined. - """ - DECLINED - """ The order was canceled for an unlisted reason. """ OTHER } -""" -An auto-generated type for paginating through multiple Orders. -""" +"An auto-generated type for paginating through multiple Orders.\n" type OrderConnection { """ A list of edges. """ edges: [OrderEdge!]! + """ + A list of the nodes contained in OrderEdge. + """ + nodes: [Order!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Order and a cursor during pagination. -""" +"An auto-generated type which holds one Order and a cursor during pagination.\n" type OrderEdge { """ A cursor for use in pagination. @@ -7029,16 +8716,16 @@ type OrderEdge { Represents the order's current financial status. """ enum OrderFinancialStatus { - """ - Displayed as **Pending**. - """ - PENDING - """ Displayed as **Authorized**. """ AUTHORIZED + """ + Displayed as **Paid**. + """ + PAID + """ Displayed as **Partially paid**. """ @@ -7050,64 +8737,69 @@ enum OrderFinancialStatus { PARTIALLY_REFUNDED """ - Displayed as **Voided**. + Displayed as **Pending**. """ - VOIDED - - """ - Displayed as **Paid**. - """ - PAID + PENDING """ Displayed as **Refunded**. """ REFUNDED + + """ + Displayed as **Voided**. + """ + VOIDED } """ -Represents the order's current fulfillment status. +Represents the order's aggregated fulfillment status for display purposes. """ enum OrderFulfillmentStatus { """ - Displayed as **Unfulfilled**. - """ - UNFULFILLED - - """ - Displayed as **Partially fulfilled**. - """ - PARTIALLY_FULFILLED - - """ - Displayed as **Fulfilled**. + Displayed as **Fulfilled**. All of the items in the order have been fulfilled. """ FULFILLED """ - Displayed as **Restocked**. - """ - RESTOCKED - - """ - Displayed as **Pending fulfillment**. - """ - PENDING_FULFILLMENT - - """ - Displayed as **Open**. - """ - OPEN - - """ - Displayed as **In progress**. + Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. """ IN_PROGRESS """ - Displayed as **Scheduled**. + Displayed as **On hold**. All of the unfulfilled items in this order are on hold. + """ + ON_HOLD + + """ + Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. + """ + OPEN + + """ + Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. + """ + PARTIALLY_FULFILLED + + """ + Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. + """ + PENDING_FULFILLMENT + + """ + Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. + """ + RESTOCKED + + """ + Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. """ SCHEDULED + + """ + Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. + """ + UNFULFILLED } """ @@ -7155,24 +8847,25 @@ type OrderLineItem { variant: ProductVariant } -""" -An auto-generated type for paginating through multiple OrderLineItems. -""" +"An auto-generated type for paginating through multiple OrderLineItems.\n" type OrderLineItemConnection { """ A list of edges. """ edges: [OrderLineItemEdge!]! + """ + A list of the nodes contained in OrderLineItemEdge. + """ + nodes: [OrderLineItem!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one OrderLineItem and a cursor during pagination. -""" +"An auto-generated type which holds one OrderLineItem and a cursor during pagination.\n" type OrderLineItemEdge { """ A cursor for use in pagination. @@ -7189,33 +8882,29 @@ type OrderLineItemEdge { The set of valid sort keys for the Order query. """ enum OrderSortKeys { - """ - Sort by the `processed_at` value. - """ - PROCESSED_AT - - """ - Sort by the `total_price` value. - """ - TOTAL_PRICE - """ Sort by the `id` value. """ ID """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `processed_at` value. """ + PROCESSED_AT + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" RELEVANCE + + """ + Sort by the `total_price` value. + """ + TOTAL_PRICE } """ Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. """ -type Page implements Node { +type Page implements HasMetafields & Node & OnlineStorePublishable { """ The description of the page, complete with HTML formatting. """ @@ -7237,10 +8926,38 @@ type Page implements Node { handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! + """ + Returns a metafield found by namespace and key. + """ + metafield( + """ + The identifier for the metafield. + """ + key: String! + + """ + A container for a set of metafields. + """ + namespace: String! + ): Metafield + + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( + """ + The list of metafields to retrieve by namespace and key. + """ + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! + + """ + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. + """ + onlineStoreUrl: URL + """ The page's SEO information. """ @@ -7255,31 +8972,27 @@ type Page implements Node { The timestamp of the latest page update. """ updatedAt: DateTime! - - """ - The url pointing to the page accessible from the web. - """ - url: URL! } -""" -An auto-generated type for paginating through multiple Pages. -""" +"An auto-generated type for paginating through multiple Pages.\n" type PageConnection { """ A list of edges. """ edges: [PageEdge!]! + """ + A list of the nodes contained in PageEdge. + """ + nodes: [Page!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Page and a cursor during pagination. -""" +"An auto-generated type which holds one Page and a cursor during pagination.\n" type PageEdge { """ A cursor for use in pagination. @@ -7292,25 +9005,41 @@ type PageEdge { node: Page! } -""" -Information about pagination in a connection. -""" +"Returns information about pagination in a connection, in accordance with the\n[Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).\n" type PageInfo { """ - Indicates if there are more pages to fetch. + The cursor corresponding to the last node in edges. + """ + endCursor: String + + """ + Whether there are more pages to fetch following the current page. """ hasNextPage: Boolean! """ - Indicates if there are any pages prior to the current page. + Whether there are any pages prior to the current page. """ hasPreviousPage: Boolean! + + """ + The cursor corresponding to the first node in edges. + """ + startCursor: String } """ The set of valid sort keys for the Page query. """ enum PageSortKeys { + """ + Sort by the `id` value. + """ + ID + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE + """ Sort by the `title` value. """ @@ -7320,18 +9049,6 @@ enum PageSortKeys { Sort by the `updated_at` value. """ UPDATED_AT - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE } """ @@ -7341,7 +9058,7 @@ type Payment implements Node { """ The amount of the payment. """ - amount: Money! @deprecated(reason: "Use `amountV2` instead") + amount: Money! @deprecated(reason: "Use `amountV2` instead.") """ The amount of the payment. @@ -7369,15 +9086,11 @@ type Payment implements Node { errorMessage: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! - """ - A client-side generated token to identify a payment and perform idempotent operations. - For more information, refer to - [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). - """ + "A client-side generated token to identify a payment and perform idempotent operations.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n" idempotencyKey: String """ @@ -7386,7 +9099,7 @@ type Payment implements Node { nextActionUrl: URL """ - Whether or not the payment is still processing asynchronously. + Whether the payment is still processing asynchronously. """ ready: Boolean! @@ -7451,9 +9164,9 @@ enum PaymentTokenType { APPLE_PAY """ - Vault payment token type. + Google Pay token type. """ - VAULT + GOOGLE_PAY """ Shopify Pay token type. @@ -7461,9 +9174,29 @@ enum PaymentTokenType { SHOPIFY_PAY """ - Google Pay token type. + Stripe token type. """ - GOOGLE_PAY + STRIPE_VAULT_TOKEN + + """ + Vault payment token type. + """ + VAULT +} + +""" +A filter used to view a subset of products in a collection matching a specific price range. +""" +input PriceRangeFilter { + """ + The maximum price in the range. Empty indicates no max price. + """ + max: Float + + """ + The minimum price in the range. Defaults to zero. + """ + min: Float = 0 } """ @@ -7485,7 +9218,7 @@ union PricingValue = MoneyV2 | PricingPercentageValue A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). """ -type Product implements Node & HasMetafields { +type Product implements HasMetafields & Node & OnlineStorePublishable { """ Indicates if at least one product variant is available for sale. """ @@ -7495,26 +9228,26 @@ type Product implements Node & HasMetafields { List of collections a product belongs to. """ collections( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -7546,14 +9279,14 @@ type Product implements Node & HasMetafields { """ descriptionHtml: HTML! - """ - A human-friendly unique string for the Product automatically generated from its title. - They are used by the Liquid templating language to refer to objects. - """ + "The featured image for the product.\n\nThis field is functionally equivalent to `images(first: 1)`.\n" + featuredImage: Image + + "A human-friendly unique string for the Product automatically generated from its title.\nThey are used by the Liquid templating language to refer to objects.\n" handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -7561,26 +9294,26 @@ type Product implements Node & HasMetafields { List of images associated with the product. """ images( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -7590,52 +9323,32 @@ type Product implements Node & HasMetafields { Sort the underlying list by the given key. """ sortKey: ProductImageSortKeys = POSITION - - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 ): ImageConnection! """ The media associated with the product. """ media( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -7648,58 +9361,30 @@ type Product implements Node & HasMetafields { ): MediaConnection! """ - The metafield associated with the resource. + Returns a metafield found by namespace and key. """ metafield( """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). + The identifier for the metafield. """ key: String! + + """ + A container for a set of metafields. + """ + namespace: String! ): Metafield - """ - A paginated list of metafields associated with the resource. - """ + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" metafields( """ - Container for a set of metafields (maximum of 20 characters). + The list of metafields to retrieve by namespace and key. """ - namespace: String - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! """ - The online store URL for the product. - A value of `null` indicates that the product is not published to the Online Store sales channel. + The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. """ onlineStoreUrl: URL @@ -7713,41 +9398,6 @@ type Product implements Node & HasMetafields { first: Int ): [ProductOption!]! - """ - List of price ranges in the presentment currencies for this shop. - """ - presentmentPriceRanges( - """ - Specifies the presentment currencies to return a price range in. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): ProductPriceRangeConnection! - """ The price range. """ @@ -7763,15 +9413,47 @@ type Product implements Node & HasMetafields { """ publishedAt: DateTime! + """ + Whether the product can only be purchased with a selling plan. + """ + requiresSellingPlan: Boolean! + + """ + A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. + """ + sellingPlanGroups( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): SellingPlanGroupConnection! + """ The product's SEO information. """ seo: SEO! - """ - A comma separated list of tags that have been added to the product. - Additional access scope required for private apps: unauthenticated_read_product_tags. - """ + "A comma separated list of tags that have been added to the product.\nAdditional access scope required for private apps: unauthenticated_read_product_tags.\n" tags: [String!]! """ @@ -7784,19 +9466,10 @@ type Product implements Node & HasMetafields { """ totalInventory: Int - """ - The date and time when the product was last modified. - A product's `updatedAt` value can change for different reasons. For example, if an order - is placed for a product that has inventory tracking set up, then the inventory adjustment - is counted as an update. - """ + "The date and time when the product was last modified.\nA product's `updatedAt` value can change for different reasons. For example, if an order\nis placed for a product that has inventory tracking set up, then the inventory adjustment\nis counted as an update.\n" updatedAt: DateTime! - """ - Find a product’s variant based on its selected options. - This is useful for converting a user’s selection of product options into a single matching variant. - If there is not a variant for the selected options, `null` will be returned. - """ + "Find a product’s variant based on its selected options.\nThis is useful for converting a user’s selection of product options into a single matching variant.\nIf there is not a variant for the selected options, `null` will be returned.\n" variantBySelectedOptions( """ The input fields used for a selected option. @@ -7808,26 +9481,26 @@ type Product implements Node & HasMetafields { List of the product’s variants. """ variants( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String - """ - Returns up to the last `n` elements from the list. - """ - last: Int - """ Returns the elements that come before the specified cursor. """ before: String + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + """ Reverse the order of the underlying list. """ @@ -7849,21 +9522,16 @@ type Product implements Node & HasMetafields { The set of valid sort keys for the ProductCollection query. """ enum ProductCollectionSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `price` value. - """ - PRICE - """ Sort by the `best-selling` value. """ BEST_SELLING + """ + Sort by the `collection-default` value. + """ + COLLECTION_DEFAULT + """ Sort by the `created` value. """ @@ -7880,36 +9548,43 @@ enum ProductCollectionSortKeys { MANUAL """ - Sort by the `collection-default` value. + Sort by the `price` value. """ - COLLECTION_DEFAULT + PRICE + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `title` value. """ - RELEVANCE + TITLE } -""" -An auto-generated type for paginating through multiple Products. -""" +"An auto-generated type for paginating through multiple Products.\n" type ProductConnection { """ A list of edges. """ edges: [ProductEdge!]! + """ + A list of available filters. + """ + filters: [Filter!]! + + """ + A list of the nodes contained in ProductEdge. + """ + nodes: [Product!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one Product and a cursor during pagination. -""" +"An auto-generated type which holds one Product and a cursor during pagination.\n" type ProductEdge { """ A cursor for use in pagination. @@ -7922,6 +9597,46 @@ type ProductEdge { node: Product! } +""" +A filter used to view a subset of products in a collection. +""" +input ProductFilter { + """ + Filter on if the product is available for sale. + """ + available: Boolean + + """ + A range of prices to filter with-in. + """ + price: PriceRangeFilter + + """ + A product metafield to filter on. + """ + productMetafield: MetafieldFilter + + """ + The product type to filter on. + """ + productType: String + + """ + The product vendor to filter on. + """ + productVendor: String + + """ + A variant metafield to filter on. + """ + variantMetafield: MetafieldFilter + + """ + A variant option to filter on. + """ + variantOption: VariantOptionFilter +} + """ The set of valid sort keys for the ProductImage query. """ @@ -7931,21 +9646,17 @@ enum ProductImageSortKeys { """ CREATED_AT - """ - Sort by the `position` value. - """ - POSITION - """ Sort by the `id` value. """ ID """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `position` value. """ + POSITION + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" RELEVANCE } @@ -7953,32 +9664,24 @@ enum ProductImageSortKeys { The set of valid sort keys for the ProductMedia query. """ enum ProductMediaSortKeys { - """ - Sort by the `position` value. - """ - POSITION - """ Sort by the `id` value. """ ID """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `position` value. """ + POSITION + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" RELEVANCE } -""" -Product property names like "Size", "Color", and "Material" that the customers can select. -Variants are selected based on permutations of these options. -255 characters limit each. -""" +"Product property names like \"Size\", \"Color\", and \"Material\" that the customers can select.\nVariants are selected based on permutations of these options.\n255 characters limit each.\n" type ProductOption implements Node { """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -8008,59 +9711,14 @@ type ProductPriceRange { minVariantPrice: MoneyV2! } -""" -An auto-generated type for paginating through multiple ProductPriceRanges. -""" -type ProductPriceRangeConnection { - """ - A list of edges. - """ - edges: [ProductPriceRangeEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one ProductPriceRange and a cursor during pagination. -""" -type ProductPriceRangeEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductPriceRangeEdge. - """ - node: ProductPriceRange! -} - """ The set of valid sort keys for the Product query. """ enum ProductSortKeys { """ - Sort by the `title` value. + Sort by the `best_selling` value. """ - TITLE - - """ - Sort by the `product_type` value. - """ - PRODUCT_TYPE - - """ - Sort by the `vendor` value. - """ - VENDOR - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT + BEST_SELLING """ Sort by the `created_at` value. @@ -8068,9 +9726,9 @@ enum ProductSortKeys { CREATED_AT """ - Sort by the `best_selling` value. + Sort by the `id` value. """ - BEST_SELLING + ID """ Sort by the `price` value. @@ -8078,36 +9736,47 @@ enum ProductSortKeys { PRICE """ - Sort by the `id` value. + Sort by the `product_type` value. """ - ID + PRODUCT_TYPE + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. + Sort by the `title` value. """ - RELEVANCE + TITLE + + """ + Sort by the `updated_at` value. + """ + UPDATED_AT + + """ + Sort by the `vendor` value. + """ + VENDOR } """ A product variant represents a different version of a product, such as differing sizes or differing colors. """ -type ProductVariant implements Node & HasMetafields { - """ - Indicates if the product variant is in stock. - """ - available: Boolean @deprecated(reason: "Use `availableForSale` instead") - +type ProductVariant implements HasMetafields & Node { """ Indicates if the product variant is available for sale. """ availableForSale: Boolean! + """ + The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. + """ + barcode: String + """ The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. """ - compareAtPrice: Money @deprecated(reason: "Use `compareAtPriceV2` instead") + compareAtPrice: Money @deprecated(reason: "Use `compareAtPriceV2` instead.") """ The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. @@ -8120,159 +9789,40 @@ type ProductVariant implements Node & HasMetafields { currentlyNotInStock: Boolean! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! - """ - Image associated with the product variant. This field falls back to the product image if no image is available. - """ - image( - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image + "Image associated with the product variant. This field falls back to the product image if no image is available.\n" + image: Image """ - The metafield associated with the resource. + Returns a metafield found by namespace and key. """ metafield( """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). + The identifier for the metafield. """ key: String! + + """ + A container for a set of metafields. + """ + namespace: String! ): Metafield - """ - A paginated list of metafields associated with the resource. - """ + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" metafields( """ - Container for a set of metafields (maximum of 20 characters). + The list of metafields to retrieve by namespace and key. """ - namespace: String - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! - - """ - List of prices and compare-at prices in the presentment currencies for this shop. - """ - presentmentPrices( - """ - The presentment currencies prices should return in. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): ProductVariantPricePairConnection! - - """ - List of unit prices in the presentment currencies for this shop. - """ - presentmentUnitPrices( - """ - Specify the currencies in which to return presentment unit prices. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MoneyV2Connection! + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! """ The product variant’s price. """ - price: Money! @deprecated(reason: "Use `priceV2` instead") + price: Money! @deprecated(reason: "Use `priceV2` instead.") """ The product variant’s price. @@ -8299,11 +9849,71 @@ type ProductVariant implements Node & HasMetafields { """ selectedOptions: [SelectedOption!]! + """ + Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. + """ + sellingPlanAllocations( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): SellingPlanAllocationConnection! + """ The SKU (stock keeping unit) associated with the variant. """ sku: String + """ + The in-store pickup availability of this variant by location. + """ + storeAvailability( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): StoreAvailabilityConnection! + """ The product variant’s title. """ @@ -8330,24 +9940,25 @@ type ProductVariant implements Node & HasMetafields { weightUnit: WeightUnit! } -""" -An auto-generated type for paginating through multiple ProductVariants. -""" +"An auto-generated type for paginating through multiple ProductVariants.\n" type ProductVariantConnection { """ A list of edges. """ edges: [ProductVariantEdge!]! + """ + A list of the nodes contained in ProductVariantEdge. + """ + nodes: [ProductVariant!]! + """ Information to aid in pagination. """ pageInfo: PageInfo! } -""" -An auto-generated type which holds one ProductVariant and a cursor during pagination. -""" +"An auto-generated type which holds one ProductVariant and a cursor during pagination.\n" type ProductVariantEdge { """ A cursor for use in pagination. @@ -8360,59 +9971,22 @@ type ProductVariantEdge { node: ProductVariant! } -""" -The compare-at price and price of a variant sharing a currency. -""" -type ProductVariantPricePair { - """ - The compare-at price of the variant with associated currency. - """ - compareAtPrice: MoneyV2 - - """ - The price of the variant with associated currency. - """ - price: MoneyV2! -} - -""" -An auto-generated type for paginating through multiple ProductVariantPricePairs. -""" -type ProductVariantPricePairConnection { - """ - A list of edges. - """ - edges: [ProductVariantPricePairEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. -""" -type ProductVariantPricePairEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductVariantPricePairEdge. - """ - node: ProductVariantPricePair! -} - """ The set of valid sort keys for the ProductVariant query. """ enum ProductVariantSortKeys { """ - Sort by the `title` value. + Sort by the `id` value. """ - TITLE + ID + + """ + Sort by the `position` value. + """ + POSITION + + "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n" + RELEVANCE """ Sort by the `sku` value. @@ -8420,21 +9994,9 @@ enum ProductVariantSortKeys { SKU """ - Sort by the `position` value. + Sort by the `title` value. """ - POSITION - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE + TITLE } """ @@ -8445,25 +10007,28 @@ type QueryRoot { List of the shop's articles. """ articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `author`\n - `blog_title`\n - `created_at`\n - `tag`\n - `tag_not`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -8474,21 +10039,23 @@ type QueryRoot { Sort the underlying list by the given key. """ sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): ArticleConnection! + """ + Fetch a specific `Blog` by one of its unique attributes. + """ + blog( + """ + The handle of the `Blog`. + """ + handle: String + + """ + The ID of the `Blog`. + """ + id: ID + ): Blog + """ Find a blog by its handle. """ @@ -8497,31 +10064,34 @@ type QueryRoot { The handle of the blog. """ handle: String! - ): Blog + ): Blog @deprecated(reason: "Use `blog` instead.") """ List of the shop's blogs. """ blogs( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `created_at`\n - `handle`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -8532,20 +10102,33 @@ type QueryRoot { Sort the underlying list by the given key. """ sortKey: BlogSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): BlogConnection! + """ + Retrieve a cart by its ID. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/api/examples/cart). + """ + cart( + """ + The ID of the cart. + """ + id: ID! + ): Cart + + """ + Fetch a specific `Collection` by one of its unique attributes. + """ + collection( + """ + The handle of the `Collection`. + """ + handle: String + + """ + The ID of the `Collection`. + """ + id: ID + ): Collection + """ Find a collection by its handle. """ @@ -8554,31 +10137,34 @@ type QueryRoot { The handle of the collection. """ handle: String! - ): Collection + ): Collection @deprecated(reason: "Use `collection` instead.") """ List of the shop’s collections. """ collections( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `collection_type`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -8589,17 +10175,6 @@ type QueryRoot { Sort the underlying list by the given key. """ sortKey: CollectionSortKeys = ID - - """ - Supported filter parameters: - - `collection_type` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): CollectionConnection! """ @@ -8612,6 +10187,59 @@ type QueryRoot { customerAccessToken: String! ): Customer + """ + Returns the localized experiences configured for the shop. + """ + localization: Localization! + + "List of the shop's locations that support in-store pickup.\n\nWhen sorting by distance, you must specify a location via the `near` argument.\n" + locations( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Used to sort results based on proximity to the provided location. + """ + near: GeoCoordinateInput + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + + """ + Sort the underlying list by the given key. + """ + sortKey: LocationSortKeys = ID + ): LocationConnection! + + """ + A storefront menu. + """ + menu( + """ + Returns a storefront menu by the specified handle. + """ + handle: String! + ): Menu + """ Returns a specific node by ID. """ @@ -8632,6 +10260,21 @@ type QueryRoot { ids: [ID!]! ): [Node]! + """ + Fetch a specific `Page` by one of its unique attributes. + """ + page( + """ + The handle of the `Page`. + """ + handle: String + + """ + The ID of the `Page`. + """ + id: ID + ): Page + """ Find a page by its handle. """ @@ -8640,31 +10283,34 @@ type QueryRoot { The handle of the page. """ handle: String! - ): Page + ): Page @deprecated(reason: "Use `page` instead.") """ List of the shop's pages. """ pages( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `created_at`\n - `handle`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -8675,35 +10321,34 @@ type QueryRoot { Sort the underlying list by the given key. """ sortKey: PageSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): PageConnection! + """ + Fetch a specific `Product` by one of its unique attributes. + """ + product( + """ + The handle of the `Product`. + """ + handle: String + + """ + The ID of the `Product`. + """ + id: ID + ): Product + """ Find a product by its handle. """ productByHandle( """ - The handle of the product. + A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: `-`. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called `Potion`, then their handles would be `potion` and `potion-1`. After a product has been created, changing the product title doesn't update the handle. """ handle: String! - ): Product + ): Product @deprecated(reason: "Use `product` instead.") - """ - Find recommended products related to a given `product_id`. - To learn more about how recommendations are generated, see - [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). - """ + "Find recommended products related to a given `product_id`.\nTo learn more about how recommendations are generated, see\n[*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products).\n" productRecommendations( """ The id of the product. @@ -8711,10 +10356,7 @@ type QueryRoot { productId: ID! ): [Product!] - """ - Tags added to products. - Additional access scope required: unauthenticated_read_product_tags. - """ + "Tags added to products.\nAdditional access scope required: unauthenticated_read_product_tags.\n" productTags( """ Returns up to the first `n` elements from the list. @@ -8736,25 +10378,28 @@ type QueryRoot { List of the shop’s products. """ products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - """ Returns the elements that come after the specified cursor. """ after: String + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + """ Returns up to the last `n` elements from the list. """ last: Int - """ - Returns the elements that come before the specified cursor. - """ - before: String + "Supported filter parameters:\n - `available_for_sale`\n - `created_at`\n - `product_type`\n - `tag`\n - `tag_not`\n - `title`\n - `updated_at`\n - `variants.price`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n" + query: String """ Reverse the order of the underlying list. @@ -8765,22 +10410,6 @@ type QueryRoot { Sort the underlying list by the given key. """ sortKey: ProductSortKeys = ID - - """ - Supported filter parameters: - - `available_for_sale` - - `created_at` - - `product_type` - - `tag` - - `title` - - `updated_at` - - `variants.price` - - `vendor` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String ): ProductConnection! """ @@ -8792,6 +10421,36 @@ type QueryRoot { The shop associated with the storefront access token. """ shop: Shop! + + """ + A list of redirects for a shop. + """ + urlRedirects( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): UrlRedirectConnection! } """ @@ -8809,21 +10468,13 @@ type SEO { title: String } -""" -Script discount applications capture the intentions of a discount that -was created by a Shopify Script. -""" +"Script discount applications capture the intentions of a discount that\nwas created by a Shopify Script.\n" type ScriptDiscountApplication implements DiscountApplication { """ The method by which the discount's value is allocated to its entitled items. """ allocationMethod: DiscountApplicationAllocationMethod! - """ - The description of the application as defined by the Script. - """ - description: String! @deprecated(reason: "Use `title` instead") - """ Which lines of targetType that the discount is allocated over. """ @@ -8845,10 +10496,7 @@ type ScriptDiscountApplication implements DiscountApplication { value: PricingValue! } -""" -Properties used by customers to select a product variant. -Products can have multiple options, like different sizes or colors. -""" +"Properties used by customers to select a product variant.\nProducts can have multiple options, like different sizes or colors.\n" type SelectedOption { """ The product option’s name. @@ -8876,6 +10524,371 @@ input SelectedOptionInput { value: String! } +""" +Represents how products and variants can be sold and purchased. +""" +type SellingPlan { + """ + The initial payment due for the purchase. + """ + checkoutCharge: SellingPlanCheckoutCharge! + + """ + The description of the selling plan. + """ + description: String + + """ + A globally-unique identifier. + """ + id: ID! + + """ + The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. + """ + name: String! + + """ + The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. + """ + options: [SellingPlanOption!]! + + """ + The price adjustments that a selling plan makes when a variant is purchased with a selling plan. + """ + priceAdjustments: [SellingPlanPriceAdjustment!]! + + """ + Whether purchasing the selling plan will result in multiple deliveries. + """ + recurringDeliveries: Boolean! +} + +""" +Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. +""" +type SellingPlanAllocation { + """ + The checkout charge amount due for the purchase. + """ + checkoutChargeAmount: MoneyV2! + + """ + A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it. + """ + priceAdjustments: [SellingPlanAllocationPriceAdjustment!]! + + """ + The remaining balance charge amount due for the purchase. + """ + remainingBalanceChargeAmount: MoneyV2! + + """ + 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'. + """ + sellingPlan: SellingPlan! +} + +"An auto-generated type for paginating through multiple SellingPlanAllocations.\n" +type SellingPlanAllocationConnection { + """ + A list of edges. + """ + edges: [SellingPlanAllocationEdge!]! + + """ + A list of the nodes contained in SellingPlanAllocationEdge. + """ + nodes: [SellingPlanAllocation!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination.\n" +type SellingPlanAllocationEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of SellingPlanAllocationEdge. + """ + node: SellingPlanAllocation! +} + +""" +The resulting prices for variants when they're purchased with a specific selling plan. +""" +type SellingPlanAllocationPriceAdjustment { + """ + The price of the variant when it's purchased without a selling plan for the same number of deliveries. For example, if a customer purchases 6 deliveries of $10.00 granola separately, then the price is 6 x $10.00 = $60.00. + """ + compareAtPrice: MoneyV2! + + """ + The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00. + """ + perDeliveryPrice: MoneyV2! + + """ + The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00. + """ + price: MoneyV2! + + """ + The resulting price per unit for the variant associated with the selling plan. If the variant isn't sold by quantity or measurement, then this field returns `null`. + """ + unitPrice: MoneyV2 +} + +""" +The initial payment due for the purchase. +""" +type SellingPlanCheckoutCharge { + """ + The charge type for the checkout charge. + """ + type: SellingPlanCheckoutChargeType! + + """ + The charge value for the checkout charge. + """ + value: SellingPlanCheckoutChargeValue! +} + +""" +The percentage value of the price used for checkout charge. +""" +type SellingPlanCheckoutChargePercentageValue { + """ + The percentage value of the price used for checkout charge. + """ + percentage: Float! +} + +""" +The checkout charge when the full amount isn't charged at checkout. +""" +enum SellingPlanCheckoutChargeType { + """ + The checkout charge is a percentage of the product or variant price. + """ + PERCENTAGE + + """ + The checkout charge is a fixed price amount. + """ + PRICE +} + +""" +The portion of the price to be charged at checkout. +""" +union SellingPlanCheckoutChargeValue = + MoneyV2 + | SellingPlanCheckoutChargePercentageValue + +"An auto-generated type for paginating through multiple SellingPlans.\n" +type SellingPlanConnection { + """ + A list of edges. + """ + edges: [SellingPlanEdge!]! + + """ + A list of the nodes contained in SellingPlanEdge. + """ + nodes: [SellingPlan!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one SellingPlan and a cursor during pagination.\n" +type SellingPlanEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of SellingPlanEdge. + """ + node: SellingPlan! +} + +""" +A fixed amount that's deducted from the original variant price. For example, $10.00 off. +""" +type SellingPlanFixedAmountPriceAdjustment { + """ + The money value of the price adjustment. + """ + adjustmentAmount: MoneyV2! +} + +""" +A fixed price adjustment for a variant that's purchased with a selling plan. +""" +type SellingPlanFixedPriceAdjustment { + """ + A new price of the variant when it's purchased with the selling plan. + """ + price: MoneyV2! +} + +""" +Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. +""" +type SellingPlanGroup { + """ + A display friendly name for the app that created the selling plan group. + """ + appName: String + + """ + The name of the selling plan group. + """ + name: String! + + """ + Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. + """ + options: [SellingPlanGroupOption!]! + + """ + 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'. + """ + sellingPlans( + """ + Returns the elements that come after the specified cursor. + """ + after: String + + """ + Returns the elements that come before the specified cursor. + """ + before: String + + """ + Returns up to the first `n` elements from the list. + """ + first: Int + + """ + Returns up to the last `n` elements from the list. + """ + last: Int + + """ + Reverse the order of the underlying list. + """ + reverse: Boolean = false + ): SellingPlanConnection! +} + +"An auto-generated type for paginating through multiple SellingPlanGroups.\n" +type SellingPlanGroupConnection { + """ + A list of edges. + """ + edges: [SellingPlanGroupEdge!]! + + """ + A list of the nodes contained in SellingPlanGroupEdge. + """ + nodes: [SellingPlanGroup!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one SellingPlanGroup and a cursor during pagination.\n" +type SellingPlanGroupEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of SellingPlanGroupEdge. + """ + node: SellingPlanGroup! +} + +""" +Represents an option on a selling plan group that's available in the drop-down list in the storefront. + +Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. +""" +type SellingPlanGroupOption { + """ + The name of the option. For example, 'Delivery every'. + """ + name: String! + + """ + The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. + """ + values: [String!]! +} + +""" +An option provided by a Selling Plan. +""" +type SellingPlanOption { + """ + The name of the option (ie "Delivery every"). + """ + name: String + + """ + The value of the option (ie "Month"). + """ + value: String +} + +""" +A percentage amount that's deducted from the original variant price. For example, 10% off. +""" +type SellingPlanPercentagePriceAdjustment { + """ + The percentage value of the price adjustment. + """ + adjustmentPercentage: Int! +} + +""" +Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. +""" +type SellingPlanPriceAdjustment { + """ + The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. + """ + adjustmentValue: SellingPlanPriceAdjustmentValue! + + """ + The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. + """ + orderCount: Int +} + +""" +Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. +""" +union SellingPlanPriceAdjustmentValue = + SellingPlanFixedAmountPriceAdjustment + | SellingPlanFixedPriceAdjustment + | SellingPlanPercentagePriceAdjustment + """ A shipping rate to be applied to a checkout. """ @@ -8888,7 +10901,7 @@ type ShippingRate { """ Price of this shipping rate. """ - price: Money! @deprecated(reason: "Use `priceV2` instead") + price: Money! @deprecated(reason: "Use `priceV2` instead.") """ Price of this shipping rate. @@ -8904,171 +10917,40 @@ type ShippingRate { """ Shop represents a collection of the general settings and information about the shop. """ -type Shop { - """ - List of the shop' articles. - """ - articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ArticleConnection! @deprecated(reason: "Use `QueryRoot.articles` instead.") - - """ - List of the shop' blogs. - """ - blogs( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: BlogSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): BlogConnection! @deprecated(reason: "Use `QueryRoot.blogs` instead.") - - """ - Find a collection by its handle. - """ - collectionByHandle( - """ - The handle of the collection. - """ - handle: String! - ): Collection - @deprecated(reason: "Use `QueryRoot.collectionByHandle` instead.") - - """ - List of the shop’s collections. - """ - collections( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: CollectionSortKeys = ID - - """ - Supported filter parameters: - - `collection_type` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): CollectionConnection! - @deprecated(reason: "Use `QueryRoot.collections` instead.") - - """ - The three-letter code for the currency that the shop accepts. - """ - currencyCode: CurrencyCode! - @deprecated(reason: "Use `paymentSettings` instead") - +type Shop implements HasMetafields & Node { """ A description of the shop. """ description: String + """ + A globally-unique identifier. + """ + id: ID! + + """ + Returns a metafield found by namespace and key. + """ + metafield( + """ + The identifier for the metafield. + """ + key: String! + + """ + A container for a set of metafields. + """ + namespace: String! + ): Metafield + + "The metafields associated with the resource matching the supplied list of namespaces and keys.\n" + metafields( + """ + The list of metafields to retrieve by namespace and key. + """ + identifiers: [HasMetafieldsIdentifier!]! + ): [Metafield]! + """ A string representing the way currency is formatted when the currency isn’t specified. """ @@ -9085,7 +10967,7 @@ type Shop { paymentSettings: PaymentSettings! """ - The shop’s primary domain. + The primary domain of the shop’s Online Store. """ primaryDomain: Domain! @@ -9094,90 +10976,6 @@ type Shop { """ privacyPolicy: ShopPolicy - """ - Find a product by its handle. - """ - productByHandle( - """ - The handle of the product. - """ - handle: String! - ): Product @deprecated(reason: "Use `QueryRoot.productByHandle` instead.") - - """ - A list of tags that have been added to products. - Additional access scope required: unauthenticated_read_product_tags. - """ - productTags( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - @deprecated(reason: "Use `QueryRoot.productTags` instead.") - - """ - List of the shop’s product types. - """ - productTypes( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - @deprecated(reason: "Use `QueryRoot.productTypes` instead.") - - """ - List of the shop’s products. - """ - products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductSortKeys = ID - - """ - Supported filter parameters: - - `available_for_sale` - - `created_at` - - `product_type` - - `tag` - - `title` - - `updated_at` - - `variants.price` - - `vendor` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ProductConnection! @deprecated(reason: "Use `QueryRoot.products` instead.") - """ The shop’s refund policy. """ @@ -9194,10 +10992,9 @@ type Shop { shipsToCountries: [CountryCode!]! """ - The shop’s Shopify Payments account id. + The shop’s subscription policy. """ - shopifyPaymentsAccountId: String - @deprecated(reason: "Use `paymentSettings` instead") + subscriptionPolicy: ShopPolicyWithDefault """ The shop’s terms of service. @@ -9220,7 +11017,7 @@ type ShopPolicy implements Node { handle: String! """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -9235,9 +11032,84 @@ type ShopPolicy implements Node { url: URL! } -""" -An auto-generated type for paginating through multiple Strings. -""" +"A policy for the store that comes with a default value, such as a subscription policy.\nIf the merchant hasn't configured a policy for their store, then the policy will return the default value.\nOtherwise, the policy will return the merchant-configured value.\n" +type ShopPolicyWithDefault { + """ + The text of the policy. Maximum size: 64KB. + """ + body: String! + + """ + The handle of the policy. + """ + handle: String! + + """ + The unique identifier of the policy. A default policy doesn't have an ID. + """ + id: ID + + """ + The title of the policy. + """ + title: String! + + """ + Public URL to the policy. + """ + url: URL! +} + +"The availability of a product variant at a particular location.\nLocal pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result.\n" +type StoreAvailability { + """ + Whether the product variant is in-stock at this location. + """ + available: Boolean! + + """ + The location where this product variant is stocked at. + """ + location: Location! + + """ + Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). + """ + pickUpTime: String! +} + +"An auto-generated type for paginating through multiple StoreAvailabilities.\n" +type StoreAvailabilityConnection { + """ + A list of edges. + """ + edges: [StoreAvailabilityEdge!]! + + """ + A list of the nodes contained in StoreAvailabilityEdge. + """ + nodes: [StoreAvailability!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one StoreAvailability and a cursor during pagination.\n" +type StoreAvailabilityEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of StoreAvailabilityEdge. + """ + node: StoreAvailability! +} + +"An auto-generated type for paginating through a list of Strings.\n" type StringConnection { """ A list of edges. @@ -9250,9 +11122,7 @@ type StringConnection { pageInfo: PageInfo! } -""" -An auto-generated type which holds one String and a cursor during pagination. -""" +"An auto-generated type which holds one String and a cursor during pagination.\n" type StringEdge { """ A cursor for use in pagination. @@ -9265,107 +11135,27 @@ type StringEdge { node: String! } -""" -Specifies the fields required to complete a checkout with -a tokenized payment. -""" -input TokenizedPaymentInput { - """ - The amount of the payment. - """ - amount: Money! - - """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). - """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! - - """ - The type of payment token. - """ - type: String! - - """ - A simple string or JSON containing the required payment data for the tokenized payment. - """ - paymentData: String! - - """ - Executes the payment in test mode if possible. Defaults to `false`. - """ - test: Boolean - - """ - Public Hash Key used for AndroidPay payments only. - """ - identifier: String -} - -""" -Specifies the fields required to complete a checkout with -a tokenized payment. -""" -input TokenizedPaymentInputV2 { - """ - The amount and currency of the payment. - """ - paymentAmount: MoneyInput! - - """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). - """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! - - """ - A simple string or JSON containing the required payment data for the tokenized payment. - """ - paymentData: String! - - """ - Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. - """ - test: Boolean - - """ - Public Hash Key used for AndroidPay payments only. - """ - identifier: String - - """ - The type of payment token. - """ - type: String! -} - -""" -Specifies the fields required to complete a checkout with -a tokenized payment. -""" +"Specifies the fields required to complete a checkout with\na tokenized payment.\n" input TokenizedPaymentInputV3 { """ - The amount and currency of the payment. + The billing address for the payment. """ - paymentAmount: MoneyInput! + billingAddress: MailingAddressInput! """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). + A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). """ idempotencyKey: String! """ - The billing address for the payment. + Public Hash Key used for AndroidPay payments only. """ - billingAddress: MailingAddressInput! + identifier: String + + """ + The amount and currency of the payment. + """ + paymentAmount: MoneyInput! """ A simple string or JSON containing the required payment data for the tokenized payment. @@ -9375,12 +11165,7 @@ input TokenizedPaymentInputV3 { """ Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. """ - test: Boolean - - """ - Public Hash Key used for AndroidPay payments only. - """ - identifier: String + test: Boolean = false """ The type of payment token. @@ -9395,7 +11180,7 @@ type Transaction { """ The amount of money that the transaction was for. """ - amount: Money! @deprecated(reason: "Use `amountV2` instead") + amount: Money! @deprecated(reason: "Use `amountV2` instead.") """ The amount of money that the transaction was for. @@ -9410,7 +11195,7 @@ type Transaction { """ The status of the transaction. """ - status: TransactionStatus! @deprecated(reason: "Use `statusV2` instead") + status: TransactionStatus! @deprecated(reason: "Use `statusV2` instead.") """ The status of the transaction. @@ -9427,10 +11212,8 @@ type Transaction { The different kinds of order transactions. """ enum TransactionKind { - """ - An authorization and capture performed together in a single step. - """ - SALE + "An amount reserved against the cardholder's funding source.\nMoney does not change hands until the authorization is captured.\n" + AUTHORIZATION """ A transfer of the money that was reserved during the authorization stage. @@ -9438,10 +11221,9 @@ enum TransactionKind { CAPTURE """ - An amount reserved against the cardholder's funding source. - Money does not change hands until the authorization is captured. + Money returned to the customer when they have paid too much. """ - AUTHORIZATION + CHANGE """ An authorization for a payment taken with an EMV credit card reader. @@ -9449,15 +11231,25 @@ enum TransactionKind { EMV_AUTHORIZATION """ - Money returned to the customer when they have paid too much. + An authorization and capture performed together in a single step. """ - CHANGE + SALE } """ Transaction statuses describe the status of a transaction. """ enum TransactionStatus { + """ + There was an error while processing the transaction. + """ + ERROR + + """ + The transaction failed. + """ + FAILURE + """ The transaction is pending. """ @@ -9467,28 +11259,12 @@ enum TransactionStatus { The transaction succeeded. """ SUCCESS - - """ - The transaction failed. - """ - FAILURE - - """ - There was an error while processing the transaction. - """ - ERROR } -""" -An RFC 3986 and RFC 3987 compliant URI string. - -Example value: `"https://johns-apparel.myshopify.com"`. -""" +"Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\n\nFor example, `\"https://johns-apparel.myshopify.com\"` is a valid URL. It includes a scheme (`https`) and a host\n(`johns-apparel.myshopify.com`).\n" scalar URL -""" -The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). -""" +"The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml).\n" type UnitPriceMeasurement { """ The type of unit of measurement for the unit price measurement. @@ -9520,6 +11296,16 @@ type UnitPriceMeasurement { The accepted types of unit of measurement. """ enum UnitPriceMeasurementMeasuredType { + """ + Unit of measurements representing areas. + """ + AREA + + """ + Unit of measurements representing lengths. + """ + LENGTH + """ Unit of measurements representing volumes. """ @@ -9529,46 +11315,21 @@ enum UnitPriceMeasurementMeasuredType { Unit of measurements representing weights. """ WEIGHT - - """ - Unit of measurements representing lengths. - """ - LENGTH - - """ - Unit of measurements representing areas. - """ - AREA } """ The valid units of measurement for a unit price measurement. """ enum UnitPriceMeasurementMeasuredUnit { - """ - 1000 milliliters equals 1 liter. - """ - ML - """ 100 centiliters equals 1 liter. """ CL """ - Metric system unit of volume. + 100 centimeters equals 1 meter. """ - L - - """ - 1 cubic meter equals 1000 liters. - """ - M3 - - """ - 1000 milligrams equals 1 gram. - """ - MG + CM """ Metric system unit of weight. @@ -9581,14 +11342,9 @@ enum UnitPriceMeasurementMeasuredUnit { KG """ - 1000 millimeters equals 1 meter. + Metric system unit of volume. """ - MM - - """ - 100 centimeters equals 1 meter. - """ - CM + L """ Metric system unit of length. @@ -9599,6 +11355,92 @@ enum UnitPriceMeasurementMeasuredUnit { Metric system unit of area. """ M2 + + """ + 1 cubic meter equals 1000 liters. + """ + M3 + + """ + 1000 milligrams equals 1 gram. + """ + MG + + """ + 1000 milliliters equals 1 liter. + """ + ML + + """ + 1000 millimeters equals 1 meter. + """ + MM +} + +""" +Systems of weights and measures. +""" +enum UnitSystem { + """ + Imperial system of weights and measures. + """ + IMPERIAL_SYSTEM + + """ + Metric system of weights and measures. + """ + METRIC_SYSTEM +} + +""" +A redirect on the online store. +""" +type UrlRedirect implements Node { + """ + The ID of the URL redirect. + """ + id: ID! + + """ + The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. + """ + path: String! + + """ + The target location where the user will be redirected to. + """ + target: String! +} + +"An auto-generated type for paginating through multiple UrlRedirects.\n" +type UrlRedirectConnection { + """ + A list of edges. + """ + edges: [UrlRedirectEdge!]! + + """ + A list of the nodes contained in UrlRedirectEdge. + """ + nodes: [UrlRedirect!]! + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +"An auto-generated type which holds one UrlRedirect and a cursor during pagination.\n" +type UrlRedirectEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of UrlRedirectEdge. + """ + node: UrlRedirect! } """ @@ -9606,7 +11448,7 @@ Represents an error in the input of a mutation. """ type UserError implements DisplayableError { """ - Path to the input field which caused the error. + The path to the input field that caused the error. """ field: [String!] @@ -9616,17 +11458,32 @@ type UserError implements DisplayableError { message: String! } +""" +A filter used to view a subset of products in a collection matching a specific variant option. +""" +input VariantOptionFilter { + """ + The name of the variant option to filter on. + """ + name: String! + + """ + The value of the variant option to filter on. + """ + value: String! +} + """ Represents a Shopify hosted video. """ -type Video implements Node & Media { +type Video implements Media & Node { """ A word or phrase to share the nature or contents of a media. """ alt: String """ - Globally unique identifier. + A globally-unique identifier. """ id: ID! @@ -9680,23 +11537,23 @@ type VideoSource { Units of measurement for weight. """ enum WeightUnit { - """ - 1 kilogram equals 1000 grams. - """ - KILOGRAMS - """ Metric system unit of mass. """ GRAMS """ - 1 pound equals 16 ounces. + 1 kilogram equals 1000 grams. """ - POUNDS + KILOGRAMS """ Imperial system unit of mass. """ OUNCES + + """ + 1 pound equals 16 ounces. + """ + POUNDS } diff --git a/packages/shopify/src/const.ts b/packages/shopify/src/const.ts index a8ee70586..fb15f9708 100644 --- a/packages/shopify/src/const.ts +++ b/packages/shopify/src/const.ts @@ -8,6 +8,6 @@ export const STORE_DOMAIN = process.env.NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN export const SHOPIFY_COOKIE_EXPIRE = 30 -export const API_URL = `https://${STORE_DOMAIN}/api/2021-07/graphql.json` +export const API_URL = `https://${STORE_DOMAIN}/api/2022-07/graphql.json` export const API_TOKEN = process.env.NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN diff --git a/packages/shopify/src/utils/normalize.ts b/packages/shopify/src/utils/normalize.ts index 2782f59dd..406c9b9cb 100644 --- a/packages/shopify/src/utils/normalize.ts +++ b/packages/shopify/src/utils/normalize.ts @@ -53,7 +53,7 @@ const normalizeProductOption = ({ } const normalizeProductImages = ({ edges }: ImageConnection) => - edges?.map(({ node: { originalSrc: url, ...rest } }) => ({ + edges?.map(({ node: { url, ...rest } }) => ({ url, ...rest, })) @@ -161,7 +161,7 @@ function normalizeLineItem({ sku: variant?.sku ?? '', name: variant?.title!, image: { - url: variant?.image?.originalSrc || '/product-img-placeholder.svg', + url: variant?.image?.url || '/product-img-placeholder.svg', }, requiresShipping: variant?.requiresShipping ?? false, price: variant?.priceV2?.amount, diff --git a/packages/shopify/src/utils/queries/get-all-products-query.ts b/packages/shopify/src/utils/queries/get-all-products-query.ts index 179cf9812..ff47df74f 100644 --- a/packages/shopify/src/utils/queries/get-all-products-query.ts +++ b/packages/shopify/src/utils/queries/get-all-products-query.ts @@ -23,7 +23,7 @@ export const productConnectionFragment = /* GraphQL */ ` } edges { node { - originalSrc + url altText width height diff --git a/packages/shopify/src/utils/queries/get-checkout-query.ts b/packages/shopify/src/utils/queries/get-checkout-query.ts index 9969e67c0..31c25bb6a 100644 --- a/packages/shopify/src/utils/queries/get-checkout-query.ts +++ b/packages/shopify/src/utils/queries/get-checkout-query.ts @@ -35,7 +35,7 @@ export const checkoutDetailsFragment = /* GraphQL */ ` value } image { - originalSrc + url altText width height diff --git a/packages/shopify/src/utils/queries/get-product-query.ts b/packages/shopify/src/utils/queries/get-product-query.ts index b2998a40a..1c4458432 100644 --- a/packages/shopify/src/utils/queries/get-product-query.ts +++ b/packages/shopify/src/utils/queries/get-product-query.ts @@ -58,7 +58,7 @@ const getProductQuery = /* GraphQL */ ` } edges { node { - originalSrc + url altText width height