; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** * An auto-generated type which holds one Article and a cursor during pagination. * */ export declare type ArticleEdge = { __typename?: 'ArticleEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ArticleEdge. */ node: Article; }; /** The set of valid sort keys for the Article query. */ export declare enum ArticleSortKeys { /** Sort by the `author` value. */ Author = "AUTHOR", /** 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", /** * 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. */ export declare type Attribute = { __typename?: 'Attribute'; /** Key or name of the attribute. */ key: Scalars['String']; /** Value of the attribute. */ value?: Maybe; }; /** The input fields for an attribute. */ export declare type AttributeInput = { /** Key or name of the attribute. */ key: Scalars['String']; /** Value of the attribute. */ value: Scalars['String']; }; /** * Automatic discount applications capture the intentions of a discount that was automatically applied. * */ export declare type AutomaticDiscountApplication = DiscountApplication & { __typename?: 'AutomaticDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ title: Scalars['String']; /** The value of the discount application. */ value: PricingValue; }; /** A collection of available shipping rates for a checkout. */ export declare type AvailableShippingRates = { __typename?: 'AvailableShippingRates'; /** * Whether or not the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. * */ ready: Scalars['Boolean']; /** The fetched shipping rates. `null` until the `ready` field is `true`. */ shippingRates?: Maybe>; }; /** Represents a cart line common fields. */ export declare type BaseCartLine = { /** 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 ID. */ 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 a cart line common fields. */ export declare type BaseCartLineAttributeArgs = { key: Scalars['String']; }; /** * An auto-generated type for paginating through multiple BaseCartLines. * */ export declare type BaseCartLineConnection = { __typename?: 'BaseCartLineConnection'; /** A list of edges. */ edges: Array; /** A list of the nodes contained in BaseCartLineEdge. */ nodes: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** * An auto-generated type which holds one BaseCartLine and a cursor during pagination. * */ export declare type BaseCartLineEdge = { __typename?: 'BaseCartLineEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of BaseCartLineEdge. */ node: BaseCartLine; }; /** An online store blog. */ export declare 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 ID. */ 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 declare type BlogArticleByHandleArgs = { handle: Scalars['String']; }; /** An online store blog. */ export declare type BlogArticlesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** An online store blog. */ export declare type BlogMetafieldArgs = { key: Scalars['String']; namespace: Scalars['String']; }; /** An online store blog. */ export declare type BlogMetafieldsArgs = { identifiers: Array; }; /** * An auto-generated type for paginating through multiple Blogs. * */ export declare 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. * */ export declare type BlogEdge = { __typename?: 'BlogEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of BlogEdge. */ node: Blog; }; /** The set of valid sort keys for the Blog query. */ export declare enum BlogSortKeys { /** Sort by the `handle` value. */ Handle = "HANDLE", /** 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" } /** * The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets). * */ export declare type Brand = { __typename?: 'Brand'; /** The colors of the store's brand. */ colors: BrandColors; /** The store's cover image. */ coverImage?: Maybe; /** The store's default logo. */ logo?: Maybe; /** The store's short description. */ shortDescription?: Maybe; /** The store's slogan. */ slogan?: Maybe; /** The store's preferred logo for square UI elements. */ squareLogo?: Maybe; }; /** * A group of related colors for the shop's brand. * */ export declare type BrandColorGroup = { __typename?: 'BrandColorGroup'; /** The background color. */ background?: Maybe; /** The foreground color. */ foreground?: Maybe; }; /** * The colors of the shop's brand. * */ export declare type BrandColors = { __typename?: 'BrandColors'; /** The shop's primary brand colors. */ primary: Array; /** The shop's secondary brand colors. */ secondary: Array; }; /** Card brand, such as Visa or Mastercard, which can be used for payments. */ export declare enum CardBrand { /** 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. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare type Cart = HasMetafields & 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/custom-storefronts/internationalization/international-pricing). */ cost: CartCost; /** The date and time when the cart was created. */ createdAt: Scalars['DateTime']; /** * The delivery groups available for the cart, based on the buyer identity default * delivery address preference or the default address of the logged-in customer. * */ deliveryGroups: CartDeliveryGroupConnection; /** The discounts that have been applied to the entire cart. */ discountAllocations: Array; /** * 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/custom-storefronts/internationalization/international-pricing). * * @deprecated Use `cost` instead. */ estimatedCost: CartEstimatedCost; /** A globally-unique ID. */ id: Scalars['ID']; /** A list of lines containing information about the items the customer intends to purchase. */ lines: BaseCartLineConnection; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the supplied list of namespaces and keys. * */ metafields: Array>; /** 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. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare type CartAttributeArgs = { key: Scalars['String']; }; /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare 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. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare type CartLinesArgs = { 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. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare type CartMetafieldArgs = { key: Scalars['String']; namespace: Scalars['String']; }; /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. * */ export declare type CartMetafieldsArgs = { identifiers: Array; }; /** Return type for `cartAttributesUpdate` mutation. */ export declare 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 declare 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 declare type CartBuyerIdentity = { __typename?: 'CartBuyerIdentity'; /** The country where the buyer is located. */ countryCode?: Maybe; /** The customer account associated with the cart. */ customer?: Maybe; /** * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. * */ deliveryAddressPreferences: Array; /** 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; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. * */ walletPreferences: Array; }; /** * Specifies the input fields to update the buyer information associated with a cart. * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. * */ export declare 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; /** * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. * */ deliveryAddressPreferences?: 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; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. * */ walletPreferences?: InputMaybe>; }; /** Return type for `cartBuyerIdentityUpdate` mutation. */ export declare type CartBuyerIdentityUpdatePayload = { __typename?: 'CartBuyerIdentityUpdatePayload'; /** The updated cart. */ cart?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** * Represents how credit card details are provided for a direct payment. * */ export declare enum CartCardSource { /** * The credit card was provided by a third party and vaulted on their system. * Using this value requires a separate permission from Shopify. * */ SavedCreditCard = "SAVED_CREDIT_CARD" } /** The discount that has been applied to the cart line using a discount code. */ export declare 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 completion action to checkout a cart. */ export declare type CartCompletionAction = CompletePaymentChallenge; /** The required completion action to checkout a cart. */ export declare type CartCompletionActionRequired = { __typename?: 'CartCompletionActionRequired'; /** The action required to complete the cart completion attempt. */ action?: Maybe; /** The ID of the cart completion attempt. */ id: Scalars['String']; }; /** The result of a cart completion attempt. */ export declare type CartCompletionAttemptResult = CartCompletionActionRequired | CartCompletionFailed | CartCompletionProcessing | CartCompletionSuccess; /** A failed completion to checkout a cart. */ export declare type CartCompletionFailed = { __typename?: 'CartCompletionFailed'; /** The errors that caused the checkout to fail. */ errors: Array; /** The ID of the cart completion attempt. */ id: Scalars['String']; }; /** A cart checkout completion that's still processing. */ export declare type CartCompletionProcessing = { __typename?: 'CartCompletionProcessing'; /** The ID of the cart completion attempt. */ id: Scalars['String']; /** The number of milliseconds to wait before polling again. */ pollDelay: Scalars['Int']; }; /** A successful completion to checkout a cart and a created order. */ export declare type CartCompletionSuccess = { __typename?: 'CartCompletionSuccess'; /** The date and time when the job completed. */ completedAt?: Maybe; /** The ID of the cart completion attempt. */ id: Scalars['String']; /** The ID of the order that's created in Shopify. */ orderId: Scalars['ID']; /** The URL of the order confirmation in Shopify. */ orderUrl: Scalars['URL']; }; /** * The costs that the buyer will pay at checkout. * The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). * */ export declare 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 declare 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 declare 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 declare type CartDeliveryGroup = { __typename?: 'CartDeliveryGroup'; /** A list of cart lines for the delivery group. */ cartLines: BaseCartLineConnection; /** The destination address for the delivery group. */ deliveryAddress: MailingAddress; /** The delivery options available for the delivery group. */ deliveryOptions: Array; /** The ID for the delivery group. */ id: Scalars['ID']; /** The selected delivery option for the delivery group. */ selectedDeliveryOption?: Maybe; }; /** Information about the options available for one or more line items to be delivered to a specific address. */ export declare type CartDeliveryGroupCartLinesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple CartDeliveryGroups. * */ export declare 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 declare 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 declare 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 unique identifier of the delivery option. */ handle: Scalars['String']; /** The title of the delivery option. */ title?: Maybe; }; /** * The input fields for submitting direct payment method information for checkout. * */ export declare type CartDirectPaymentMethodInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** The source of the credit card payment. */ cardSource?: InputMaybe; /** The session ID for the direct payment method used to create the payment. */ sessionId: Scalars['String']; }; /** The discounts that have been applied to the cart line. */ export declare type CartDiscountAllocation = { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; }; /** The discount codes applied to the cart. */ export declare 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 declare 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 declare enum CartErrorCode { /** The input value is invalid. */ Invalid = "INVALID", /** Delivery group was not found in cart. */ InvalidDeliveryGroup = "INVALID_DELIVERY_GROUP", /** Delivery option was not valid. */ InvalidDeliveryOption = "INVALID_DELIVERY_OPTION", /** Merchandise line was not found in cart. */ InvalidMerchandiseLine = "INVALID_MERCHANDISE_LINE", /** The metafields were not valid. */ InvalidMetafields = "INVALID_METAFIELDS", /** The payment wasn't valid. */ InvalidPayment = "INVALID_PAYMENT", /** Cannot update payment on an empty cart */ InvalidPaymentEmptyCart = "INVALID_PAYMENT_EMPTY_CART", /** 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 payment method is not supported. */ PaymentMethodNotSupported = "PAYMENT_METHOD_NOT_SUPPORTED" } /** * The estimated costs that the buyer will pay at checkout. * The estimated cost uses * [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) * to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). * */ export declare 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; }; /** * The input fields for submitting a billing address without a selected payment method. * */ export declare type CartFreePaymentMethodInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; }; /** The input fields to create a cart. */ export declare 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/custom-storefronts/internationalization/international-pricing). * 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>; /** The metafields to associate with this cart. */ metafields?: InputMaybe>; /** A note that is associated with the cart. For example, the note can be a personalized message to the buyer. */ note?: InputMaybe; }; /** The input fields for a cart metafield value to set. */ export declare type CartInputMetafieldInput = { /** The key name of the metafield. */ key: Scalars['String']; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). * */ type: Scalars['String']; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. * */ value: Scalars['String']; }; /** Represents information about the merchandise in the cart. */ export declare type CartLine = BaseCartLine & 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 ID. */ 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 declare type CartLineAttributeArgs = { key: Scalars['String']; }; /** The cost of the merchandise line that the buyer will pay at checkout. */ export declare 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; }; /** The estimated cost of the merchandise line that the buyer will pay at checkout. */ export declare 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; }; /** The input fields to create a merchandise line on a cart. */ export declare type CartLineInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise that the buyer intends to purchase. */ merchandiseId: Scalars['ID']; /** The quantity of the merchandise. */ quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ sellingPlanId?: InputMaybe; }; /** The input fields to update a line item on a cart. */ export declare type CartLineUpdateInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise line. */ id: Scalars['ID']; /** The ID of the merchandise for the line item. */ merchandiseId?: InputMaybe; /** The quantity of the line item. */ quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ sellingPlanId?: InputMaybe; }; /** Return type for `cartLinesAdd` mutation. */ export declare 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 declare 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 declare type CartLinesUpdatePayload = { __typename?: 'CartLinesUpdatePayload'; /** The updated cart. */ cart?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The input fields to delete a cart metafield. */ export declare type CartMetafieldDeleteInput = { /** The key name of the cart metafield. */ key: Scalars['String']; /** The ID of the cart resource. */ ownerId: Scalars['ID']; }; /** Return type for `cartMetafieldDelete` mutation. */ export declare type CartMetafieldDeletePayload = { __typename?: 'CartMetafieldDeletePayload'; /** The ID of the deleted cart metafield. */ deletedId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The input fields for a cart metafield value to set. */ export declare type CartMetafieldsSetInput = { /** The key name of the cart metafield. */ key: Scalars['String']; /** The ID of the cart resource. */ ownerId: Scalars['ID']; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). * */ type: Scalars['String']; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. * */ value: Scalars['String']; }; /** Return type for `cartMetafieldsSet` mutation. */ export declare type CartMetafieldsSetPayload = { __typename?: 'CartMetafieldsSetPayload'; /** The list of cart metafields that were set. */ metafields?: Maybe>; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `cartNoteUpdate` mutation. */ export declare type CartNoteUpdatePayload = { __typename?: 'CartNoteUpdatePayload'; /** The updated cart. */ cart?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** * The input fields for updating the payment method that will be used to checkout. * */ export declare type CartPaymentInput = { /** The amount that the customer will be charged at checkout. */ amount: MoneyInput; /** * The input fields to use when checking out a cart with a direct payment method (like a credit card). * */ directPaymentMethod?: InputMaybe; /** * The input fields to use to checkout a cart without providing a payment method. * Use this payment method input if the total cost of the cart is 0. * */ freePaymentMethod?: InputMaybe; /** * An ID of the order placed on the originating platform. * Note that this value doesn't correspond to the Shopify Order ID. * */ sourceIdentifier?: InputMaybe; /** * The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay). * */ walletPaymentMethod?: InputMaybe; }; /** Return type for `cartPaymentUpdate` mutation. */ export declare type CartPaymentUpdatePayload = { __typename?: 'CartPaymentUpdatePayload'; /** The updated cart. */ cart?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** * The input fields for updating the selected delivery options for a delivery group. * */ export declare type CartSelectedDeliveryOptionInput = { /** The ID of the cart delivery group. */ deliveryGroupId: Scalars['ID']; /** The handle of the selected delivery option. */ deliveryOptionHandle: Scalars['String']; }; /** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */ export declare type CartSelectedDeliveryOptionsUpdatePayload = { __typename?: 'CartSelectedDeliveryOptionsUpdatePayload'; /** The updated cart. */ cart?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `cartSubmitForCompletion` mutation. */ export declare type CartSubmitForCompletionPayload = { __typename?: 'CartSubmitForCompletionPayload'; /** The result of cart submission for completion. */ result?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The result of cart submit completion. */ export declare type CartSubmitForCompletionResult = SubmitAlreadyAccepted | SubmitFailed | SubmitSuccess | SubmitThrottled; /** Represents an error that happens during execution of a cart mutation. */ export declare 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']; }; /** * The input fields for submitting wallet payment method information for checkout. * */ export declare type CartWalletPaymentMethodInput = { /** The payment method information for the Apple Pay wallet. */ applePayWalletContent?: InputMaybe; /** The payment method information for the Shop Pay wallet. */ shopPayWalletContent?: InputMaybe; }; /** A container for all the information required to checkout items and pay. */ export declare type Checkout = Node & { __typename?: 'Checkout'; /** The gift cards used on the checkout. */ appliedGiftCards: Array; /** * 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. */ currencyCode: CurrencyCode; /** A list of extra information that is added to the checkout. */ customAttributes: Array; /** Discounts that have been applied on the checkout. */ discountApplications: DiscountApplicationConnection; /** The email attached to this checkout. */ email?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection; /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ lineItemsSubtotalPrice: MoneyV2; /** The note associated with the checkout. */ note?: Maybe; /** The resulting order from a paid checkout. */ order?: Maybe; /** The Order Status Page for this Checkout, null when checkout is not completed. */ 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. */ paymentDue: MoneyV2; /** * 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. * @deprecated Use `paymentDue` instead. */ 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. * */ shippingDiscountAllocations: Array; /** Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. */ shippingLine?: Maybe; /** The price at checkout before shipping and taxes. */ subtotalPrice: MoneyV2; /** * The price at checkout before duties, shipping, and taxes. * @deprecated Use `subtotalPrice` instead. */ subtotalPriceV2: MoneyV2; /** Whether the checkout is tax exempt. */ taxExempt: Scalars['Boolean']; /** 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, including taxes and duties. */ totalPrice: MoneyV2; /** * The sum of all the prices of all the items in the checkout, including taxes and duties. * @deprecated Use `totalPrice` instead. */ totalPriceV2: MoneyV2; /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */ totalTax: MoneyV2; /** * The sum of all the taxes applied to the line items and shipping lines in the checkout. * @deprecated Use `totalTax` instead. */ totalTaxV2: MoneyV2; /** The date and time when the checkout was last updated. */ updatedAt: Scalars['DateTime']; /** The url pointing to the checkout accessible from the web. */ webUrl: Scalars['URL']; }; /** A container for all the information required to checkout items and pay. */ export declare type CheckoutDiscountApplicationsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A container for all the information required to checkout items and pay. */ export declare type CheckoutLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The input fields required to update a checkout's attributes. */ export declare type CheckoutAttributesUpdateV2Input = { /** * 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 completion time. Defaults to `false` with * each operation. * */ 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. */ export declare type CheckoutAttributesUpdateV2Payload = { __typename?: 'CheckoutAttributesUpdateV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * 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 declare type CheckoutBuyerIdentity = { __typename?: 'CheckoutBuyerIdentity'; /** The country code for the checkout. For example, `CA`. */ countryCode?: Maybe; }; /** The input fields for the identity of the customer associated with the checkout. */ export declare 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 declare type CheckoutCompleteFreePayload = { __typename?: 'CheckoutCompleteFreePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutCompleteWithCreditCardV2` mutation. */ export declare type CheckoutCompleteWithCreditCardV2Payload = { __typename?: 'CheckoutCompleteWithCreditCardV2Payload'; /** The checkout on which the payment was applied. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** A representation of the attempted payment. */ payment?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutCompleteWithTokenizedPaymentV3` mutation. */ export declare type CheckoutCompleteWithTokenizedPaymentV3Payload = { __typename?: 'CheckoutCompleteWithTokenizedPaymentV3Payload'; /** The checkout on which the payment was applied. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** A representation of the attempted payment. */ payment?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** The input fields required to create a checkout. */ export declare type CheckoutCreateInput = { /** * 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 completion time. Defaults to `null`. * */ 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. */ export declare type CheckoutCreatePayload = { __typename?: 'CheckoutCreatePayload'; /** The new checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** The checkout queue token. Available only to selected stores. */ queueToken?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutCustomerAssociateV2` mutation. */ export declare type CheckoutCustomerAssociateV2Payload = { __typename?: 'CheckoutCustomerAssociateV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** The associated customer object. */ customer?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutCustomerDisassociateV2` mutation. */ export declare type CheckoutCustomerDisassociateV2Payload = { __typename?: 'CheckoutCustomerDisassociateV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutDiscountCodeApplyV2` mutation. */ export declare type CheckoutDiscountCodeApplyV2Payload = { __typename?: 'CheckoutDiscountCodeApplyV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutDiscountCodeRemove` mutation. */ export declare type CheckoutDiscountCodeRemovePayload = { __typename?: 'CheckoutDiscountCodeRemovePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutEmailUpdateV2` mutation. */ export declare type CheckoutEmailUpdateV2Payload = { __typename?: 'CheckoutEmailUpdateV2Payload'; /** The checkout object with the updated email. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Possible error codes that can be returned by `CheckoutUserError`. */ export declare enum CheckoutErrorCode { /** Checkout is already completed. */ AlreadyCompleted = "ALREADY_COMPLETED", /** Input email contains an invalid domain name. */ BadDomain = "BAD_DOMAIN", /** The input value is blank. */ Blank = "BLANK", /** Cart does not meet discount requirements notice. */ CartDoesNotMeetDiscountRequirementsNotice = "CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE", /** 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 code isn't working right now. Please contact us for help. */ DiscountCodeApplicationFailed = "DISCOUNT_CODE_APPLICATION_FAILED", /** Discount disabled. */ DiscountDisabled = "DISCOUNT_DISABLED", /** Discount expired. */ DiscountExpired = "DISCOUNT_EXPIRED", /** Discount limit reached. */ DiscountLimitReached = "DISCOUNT_LIMIT_REACHED", /** Discount not found. */ DiscountNotFound = "DISCOUNT_NOT_FOUND", /** Checkout is already completed. */ Empty = "EMPTY", /** 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", /** Product is not published for this customer. */ ProductNotAvailable = "PRODUCT_NOT_AVAILABLE", /** 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" } /** Return type for `checkoutGiftCardRemoveV2` mutation. */ export declare type CheckoutGiftCardRemoveV2Payload = { __typename?: 'CheckoutGiftCardRemoveV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutGiftCardsAppend` mutation. */ export declare type CheckoutGiftCardsAppendPayload = { __typename?: 'CheckoutGiftCardsAppendPayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** A single line item in the checkout, grouped by variant and attributes. */ export declare type CheckoutLineItem = Node & { __typename?: 'CheckoutLineItem'; /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the checkout line item by discount applications. */ discountAllocations: Array; /** A globally-unique ID. */ id: Scalars['ID']; /** The quantity of the line item. */ quantity: Scalars['Int']; /** Title of the line item. Defaults to the product's title. */ title: Scalars['String']; /** Unit price of the line item. */ unitPrice?: Maybe; /** Product variant of the line item. */ variant?: Maybe; }; /** * An auto-generated type for paginating through multiple CheckoutLineItems. * */ export declare 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. * */ export declare type CheckoutLineItemEdge = { __typename?: 'CheckoutLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CheckoutLineItemEdge. */ node: CheckoutLineItem; }; /** The input fields to create a line item on a checkout. */ export declare type CheckoutLineItemInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The quantity of the line item. */ quantity: Scalars['Int']; /** The ID of the product variant for the line item. */ variantId: Scalars['ID']; }; /** The input fields to update a line item on the checkout. */ export declare type CheckoutLineItemUpdateInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The ID of the line item. */ id?: InputMaybe; /** The quantity of the line item. */ quantity?: InputMaybe; /** The variant ID of the line item. */ variantId?: InputMaybe; }; /** Return type for `checkoutLineItemsAdd` mutation. */ export declare type CheckoutLineItemsAddPayload = { __typename?: 'CheckoutLineItemsAddPayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutLineItemsRemove` mutation. */ export declare type CheckoutLineItemsRemovePayload = { __typename?: 'CheckoutLineItemsRemovePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutLineItemsReplace` mutation. */ export declare type CheckoutLineItemsReplacePayload = { __typename?: 'CheckoutLineItemsReplacePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `checkoutLineItemsUpdate` mutation. */ export declare type CheckoutLineItemsUpdatePayload = { __typename?: 'CheckoutLineItemsUpdatePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutShippingAddressUpdateV2` mutation. */ export declare type CheckoutShippingAddressUpdateV2Payload = { __typename?: 'CheckoutShippingAddressUpdateV2Payload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Return type for `checkoutShippingLineUpdate` mutation. */ export declare type CheckoutShippingLineUpdatePayload = { __typename?: 'CheckoutShippingLineUpdatePayload'; /** The updated checkout object. */ checkout?: Maybe; /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. */ userErrors: Array; }; /** Represents an error that happens during execution of a checkout mutation. */ export declare type CheckoutUserError = DisplayableError & { __typename?: 'CheckoutUserError'; /** The error code. */ code?: Maybe; /** 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 declare 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 ID. */ 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 declare type CollectionDescriptionArgs = { 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 declare 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 declare 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 declare type CollectionProductsArgs = { after?: InputMaybe; before?: InputMaybe; filters?: InputMaybe>; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * An auto-generated type for paginating through multiple Collections. * */ export declare 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. * */ export declare type CollectionEdge = { __typename?: 'CollectionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CollectionEdge. */ node: Collection; }; /** The set of valid sort keys for the Collection query. */ export declare 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" } /** A comment on an article. */ export declare type Comment = Node & { __typename?: 'Comment'; /** The comment’s author. */ author: CommentAuthor; /** Stripped content of the comment, single line with HTML tags removed. */ content: Scalars['String']; /** The content of the comment, complete with HTML formatting. */ contentHtml: Scalars['HTML']; /** A globally-unique ID. */ id: Scalars['ID']; }; /** A comment on an article. */ export declare type CommentContentArgs = { truncateAt?: InputMaybe; }; /** The author of a comment. */ export declare type CommentAuthor = { __typename?: 'CommentAuthor'; /** The author's email. */ email: Scalars['String']; /** The author’s name. */ name: Scalars['String']; }; /** * An auto-generated type for paginating through multiple Comments. * */ export declare 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. * */ export declare type CommentEdge = { __typename?: 'CommentEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CommentEdge. */ node: Comment; }; /** The action for the 3DS payment redirect. */ export declare type CompletePaymentChallenge = { __typename?: 'CompletePaymentChallenge'; /** The URL for the 3DS payment redirect. */ redirectUrl?: Maybe; }; /** An error that occurred during a cart completion attempt. */ export declare type CompletionError = { __typename?: 'CompletionError'; /** The error code. */ code: CompletionErrorCode; /** The error message. */ message?: Maybe; }; /** The code of the error that occurred during a cart completion attempt. */ export declare enum CompletionErrorCode { Error = "ERROR", InventoryReservationError = "INVENTORY_RESERVATION_ERROR", PaymentAmountTooSmall = "PAYMENT_AMOUNT_TOO_SMALL", PaymentCallIssuer = "PAYMENT_CALL_ISSUER", PaymentCardDeclined = "PAYMENT_CARD_DECLINED", PaymentError = "PAYMENT_ERROR", PaymentGatewayNotEnabledError = "PAYMENT_GATEWAY_NOT_ENABLED_ERROR", PaymentInsufficientFunds = "PAYMENT_INSUFFICIENT_FUNDS", PaymentInvalidBillingAddress = "PAYMENT_INVALID_BILLING_ADDRESS", PaymentInvalidCreditCard = "PAYMENT_INVALID_CREDIT_CARD", PaymentInvalidCurrency = "PAYMENT_INVALID_CURRENCY", PaymentInvalidPaymentMethod = "PAYMENT_INVALID_PAYMENT_METHOD", PaymentTransientError = "PAYMENT_TRANSIENT_ERROR" } /** A country. */ export declare 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 market that includes this country. */ market?: Maybe; /** 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 declare enum CountryCode { /** Ascension Island. */ Ac = "AC", /** 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", /** Bosnia & Herzegovina. */ Ba = "BA", /** Barbados. */ Bb = "BB", /** Bangladesh. */ Bd = "BD", /** Belgium. */ Be = "BE", /** Burkina Faso. */ Bf = "BF", /** Bulgaria. */ Bg = "BG", /** Bahrain. */ Bh = "BH", /** Burundi. */ Bi = "BI", /** Benin. */ Bj = "BJ", /** St. Barthélemy. */ Bl = "BL", /** Bermuda. */ Bm = "BM", /** Brunei. */ Bn = "BN", /** Bolivia. */ Bo = "BO", /** Caribbean Netherlands. */ Bq = "BQ", /** 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", /** 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", /** Cuba. */ Cu = "CU", /** Cape Verde. */ Cv = "CV", /** Curaçao. */ Cw = "CW", /** Christmas Island. */ Cx = "CX", /** Cyprus. */ Cy = "CY", /** Czechia. */ Cz = "CZ", /** Germany. */ De = "DE", /** Djibouti. */ Dj = "DJ", /** Denmark. */ Dk = "DK", /** Dominica. */ Dm = "DM", /** Dominican Republic. */ Do = "DO", /** Algeria. */ Dz = "DZ", /** Ecuador. */ Ec = "EC", /** Estonia. */ Ee = "EE", /** 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", /** France. */ Fr = "FR", /** Gabon. */ Ga = "GA", /** United Kingdom. */ Gb = "GB", /** Grenada. */ Gd = "GD", /** Georgia. */ Ge = "GE", /** French Guiana. */ Gf = "GF", /** Guernsey. */ Gg = "GG", /** Ghana. */ Gh = "GH", /** Gibraltar. */ Gi = "GI", /** Greenland. */ Gl = "GL", /** 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", /** Hong Kong SAR. */ Hk = "HK", /** Heard & McDonald Islands. */ Hm = "HM", /** Honduras. */ Hn = "HN", /** Croatia. */ Hr = "HR", /** Haiti. */ Ht = "HT", /** Hungary. */ Hu = "HU", /** Indonesia. */ Id = "ID", /** Ireland. */ Ie = "IE", /** 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", /** Jersey. */ Je = "JE", /** Jamaica. */ Jm = "JM", /** Jordan. */ Jo = "JO", /** Japan. */ Jp = "JP", /** Kenya. */ Ke = "KE", /** 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", /** Lebanon. */ Lb = "LB", /** St. Lucia. */ Lc = "LC", /** Liechtenstein. */ Li = "LI", /** Sri Lanka. */ Lk = "LK", /** Liberia. */ Lr = "LR", /** Lesotho. */ Ls = "LS", /** Lithuania. */ Lt = "LT", /** Luxembourg. */ Lu = "LU", /** 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", /** North Macedonia. */ Mk = "MK", /** Mali. */ Ml = "ML", /** Myanmar (Burma). */ Mm = "MM", /** Mongolia. */ Mn = "MN", /** Macao SAR. */ Mo = "MO", /** Martinique. */ Mq = "MQ", /** Mauritania. */ Mr = "MR", /** Montserrat. */ Ms = "MS", /** Malta. */ Mt = "MT", /** Mauritius. */ Mu = "MU", /** Maldives. */ Mv = "MV", /** Malawi. */ Mw = "MW", /** Mexico. */ Mx = "MX", /** Malaysia. */ My = "MY", /** Mozambique. */ Mz = "MZ", /** Namibia. */ Na = "NA", /** New Caledonia. */ Nc = "NC", /** Niger. */ Ne = "NE", /** Norfolk Island. */ Nf = "NF", /** 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", /** Panama. */ Pa = "PA", /** Peru. */ Pe = "PE", /** French Polynesia. */ Pf = "PF", /** Papua New Guinea. */ Pg = "PG", /** Philippines. */ Ph = "PH", /** 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", /** Réunion. */ Re = "RE", /** Romania. */ Ro = "RO", /** Serbia. */ Rs = "RS", /** Russia. */ Ru = "RU", /** Rwanda. */ Rw = "RW", /** Saudi Arabia. */ Sa = "SA", /** Solomon Islands. */ Sb = "SB", /** Seychelles. */ Sc = "SC", /** Sudan. */ Sd = "SD", /** Sweden. */ Se = "SE", /** 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", /** Eswatini. */ Sz = "SZ", /** Tristan da Cunha. */ Ta = "TA", /** 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", /** Taiwan. */ Tw = "TW", /** Tanzania. */ Tz = "TZ", /** Ukraine. */ Ua = "UA", /** Uganda. */ Ug = "UG", /** U.S. Outlying Islands. */ Um = "UM", /** United States. */ Us = "US", /** Uruguay. */ Uy = "UY", /** Uzbekistan. */ Uz = "UZ", /** Vatican City. */ Va = "VA", /** St. Vincent & Grenadines. */ Vc = "VC", /** Venezuela. */ Ve = "VE", /** British Virgin Islands. */ Vg = "VG", /** Vietnam. */ Vn = "VN", /** Vanuatu. */ Vu = "VU", /** Wallis & Futuna. */ Wf = "WF", /** 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. */ export declare type CreditCard = { __typename?: 'CreditCard'; /** The brand of the credit card. */ brand?: Maybe; /** The expiry month of the credit card. */ expiryMonth?: Maybe; /** The expiry year of the credit card. */ expiryYear?: Maybe; /** The credit card's BIN number. */ firstDigits?: Maybe; /** The first name of the card holder. */ firstName?: Maybe; /** The last 4 digits of the credit card. */ lastDigits?: Maybe; /** The last name of the card holder. */ lastName?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ maskedNumber?: Maybe; }; /** * Specifies the fields required to complete a checkout with * a Shopify vaulted credit card payment. * */ export declare type CreditCardPaymentInputV2 = { /** 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']; }; /** The part of the image that should remain after cropping. */ export declare enum CropRegion { /** 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" } /** A currency. */ export declare 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 declare enum CurrencyCode { /** United Arab Emirates Dirham (AED). */ Aed = "AED", /** Afghan Afghani (AFN). */ Afn = "AFN", /** Albanian Lek (ALL). */ All = "ALL", /** Armenian Dram (AMD). */ Amd = "AMD", /** Netherlands Antillean Guilder. */ Ang = "ANG", /** Angolan Kwanza (AOA). */ Aoa = "AOA", /** Argentine Pesos (ARS). */ Ars = "ARS", /** Australian Dollars (AUD). */ Aud = "AUD", /** 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", /** Bulgarian Lev (BGN). */ Bgn = "BGN", /** Bahraini Dinar (BHD). */ Bhd = "BHD", /** Burundian Franc (BIF). */ Bif = "BIF", /** Bermudian Dollar (BMD). */ Bmd = "BMD", /** Brunei Dollar (BND). */ Bnd = "BND", /** 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). */ 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", /** Costa Rican Colones (CRC). */ Crc = "CRC", /** 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", /** Algerian Dinar (DZD). */ Dzd = "DZD", /** Egyptian Pound (EGP). */ Egp = "EGP", /** Eritrean Nakfa (ERN). */ Ern = "ERN", /** Ethiopian Birr (ETB). */ Etb = "ETB", /** Euro (EUR). */ Eur = "EUR", /** Fijian Dollars (FJD). */ Fjd = "FJD", /** 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", /** 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", /** Indonesian Rupiah (IDR). */ Idr = "IDR", /** Israeli New Shekel (NIS). */ Ils = "ILS", /** Indian Rupees (INR). */ Inr = "INR", /** Iraqi Dinar (IQD). */ Iqd = "IQD", /** Iranian Rial (IRR). */ Irr = "IRR", /** Icelandic Kronur (ISK). */ Isk = "ISK", /** Jersey Pound. */ Jep = "JEP", /** Jamaican Dollars (JMD). */ Jmd = "JMD", /** Jordanian Dinar (JOD). */ Jod = "JOD", /** Japanese Yen (JPY). */ Jpy = "JPY", /** Kenyan Shilling (KES). */ Kes = "KES", /** 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", /** Lebanese Pounds (LBP). */ Lbp = "LBP", /** 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", /** 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", /** Mozambican Metical. */ Mzn = "MZN", /** Namibian Dollar. */ Nad = "NAD", /** 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", /** 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", /** Saudi Riyal (SAR). */ Sar = "SAR", /** Solomon Islands Dollar (SBD). */ Sbd = "SBD", /** Seychellois Rupee (SCR). */ Scr = "SCR", /** Sudanese Pound (SDG). */ Sdg = "SDG", /** Swedish Kronor (SEK). */ Sek = "SEK", /** 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). */ 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", /** Tajikistani Somoni (TJS). */ Tjs = "TJS", /** Turkmenistani Manat (TMT). */ Tmt = "TMT", /** 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", /** Ugandan Shilling (UGX). */ Ugx = "UGX", /** United States Dollars (USD). */ Usd = "USD", /** Uruguayan Pesos (UYU). */ Uyu = "UYU", /** Uzbekistan som (UZS). */ Uzs = "UZS", /** Venezuelan Bolivares (VED). */ Ved = "VED", /** Venezuelan Bolivares (VEF). */ 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 declare type Customer = HasMetafields & { __typename?: 'Customer'; /** Indicates whether the customer has consented to be sent marketing material via email. */ acceptsMarketing: Scalars['Boolean']; /** A list of addresses for the customer. */ addresses: MailingAddressConnection; /** The date and time when the customer was created. */ createdAt: Scalars['DateTime']; /** The customer’s default address. */ defaultAddress?: Maybe; /** The customer’s name, email or phone number. */ displayName: Scalars['String']; /** The customer’s email address. */ email?: Maybe; /** The customer’s first name. */ firstName?: Maybe; /** A unique ID for the customer. */ id: Scalars['ID']; /** The customer's most recently updated, incomplete checkout. */ 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 number of orders that the customer has made at the store in their lifetime. */ numberOfOrders: Scalars['UnsignedInt64']; /** The orders associated with the customer. */ orders: OrderConnection; /** The customer’s phone number. */ phone?: Maybe; /** * 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. */ updatedAt: Scalars['DateTime']; }; /** 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 declare type CustomerAddressesArgs = { 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 declare 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 declare 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 declare type CustomerOrdersArgs = { 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. */ export declare type CustomerAccessToken = { __typename?: 'CustomerAccessToken'; /** The customer’s access token. */ accessToken: Scalars['String']; /** The date and time when the customer access token expires. */ expiresAt: Scalars['DateTime']; }; /** The input fields required to create a customer access token. */ export declare type CustomerAccessTokenCreateInput = { /** The email associated to the customer. */ email: Scalars['String']; /** The login password to be used by the customer. */ password: Scalars['String']; }; /** Return type for `customerAccessTokenCreate` mutation. */ export declare type CustomerAccessTokenCreatePayload = { __typename?: 'CustomerAccessTokenCreatePayload'; /** The newly created customer access token object. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerAccessTokenCreateWithMultipass` mutation. */ export declare type CustomerAccessTokenCreateWithMultipassPayload = { __typename?: 'CustomerAccessTokenCreateWithMultipassPayload'; /** An access token object associated with the customer. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; }; /** Return type for `customerAccessTokenDelete` mutation. */ export declare type CustomerAccessTokenDeletePayload = { __typename?: 'CustomerAccessTokenDeletePayload'; /** The destroyed access token. */ deletedAccessToken?: Maybe; /** ID of the destroyed customer access token. */ deletedCustomerAccessTokenId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `customerAccessTokenRenew` mutation. */ export declare type CustomerAccessTokenRenewPayload = { __typename?: 'CustomerAccessTokenRenewPayload'; /** The renewed customer access token object. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `customerActivateByUrl` mutation. */ export declare type CustomerActivateByUrlPayload = { __typename?: 'CustomerActivateByUrlPayload'; /** The customer that was activated. */ customer?: Maybe; /** A new customer access token for the customer. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; }; /** The input fields to activate a customer. */ export declare type CustomerActivateInput = { /** The activation token required to activate the customer. */ activationToken: Scalars['String']; /** New password that will be set during activation. */ password: Scalars['String']; }; /** Return type for `customerActivate` mutation. */ export declare type CustomerActivatePayload = { __typename?: 'CustomerActivatePayload'; /** The customer object. */ customer?: Maybe; /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerAddressCreate` mutation. */ export declare type CustomerAddressCreatePayload = { __typename?: 'CustomerAddressCreatePayload'; /** The new customer address object. */ customerAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerAddressDelete` mutation. */ export declare type CustomerAddressDeletePayload = { __typename?: 'CustomerAddressDeletePayload'; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** ID of the deleted customer address. */ deletedCustomerAddressId?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerAddressUpdate` mutation. */ export declare type CustomerAddressUpdatePayload = { __typename?: 'CustomerAddressUpdatePayload'; /** The customer’s updated mailing address. */ customerAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** The input fields to create a new customer. */ export declare type CustomerCreateInput = { /** 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?: InputMaybe; }; /** Return type for `customerCreate` mutation. */ export declare type CustomerCreatePayload = { __typename?: 'CustomerCreatePayload'; /** The created customer object. */ customer?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerDefaultAddressUpdate` mutation. */ export declare type CustomerDefaultAddressUpdatePayload = { __typename?: 'CustomerDefaultAddressUpdatePayload'; /** The updated customer object. */ customer?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Possible error codes that can be returned by `CustomerUserError`. */ export declare enum CustomerErrorCode { /** Customer already enabled. */ AlreadyEnabled = "ALREADY_ENABLED", /** Input email contains an invalid domain name. */ BadDomain = "BAD_DOMAIN", /** The input value is blank. */ Blank = "BLANK", /** Input contains HTML tags. */ ContainsHtmlTags = "CONTAINS_HTML_TAGS", /** Input contains URL. */ ContainsUrl = "CONTAINS_URL", /** 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 declare type CustomerRecoverPayload = { __typename?: 'CustomerRecoverPayload'; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Return type for `customerResetByUrl` mutation. */ export declare type CustomerResetByUrlPayload = { __typename?: 'CustomerResetByUrlPayload'; /** The customer object which was reset. */ customer?: Maybe; /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** The input fields to reset a customer's password. */ export declare type CustomerResetInput = { /** 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. */ export declare type CustomerResetPayload = { __typename?: 'CustomerResetPayload'; /** The customer object which was reset. */ customer?: Maybe; /** A newly created customer access token object for the customer. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** The input fields to update the Customer information. */ export declare type CustomerUpdateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ acceptsMarketing?: InputMaybe; /** The customer’s email. */ 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?: InputMaybe; }; /** Return type for `customerUpdate` mutation. */ export declare type CustomerUpdatePayload = { __typename?: 'CustomerUpdatePayload'; /** The updated customer object. */ customer?: Maybe; /** * 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; /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. */ userErrors: Array; }; /** Represents an error that happens during execution of a customer mutation. */ export declare type CustomerUserError = DisplayableError & { __typename?: 'CustomerUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** A delivery address of the buyer that is interacting with the cart. */ export declare type DeliveryAddress = MailingAddress; /** * The input fields for delivery address preferences. * */ export declare type DeliveryAddressInput = { /** * The ID of a customer address that is associated with the buyer that is interacting with the cart. * */ customerAddressId?: InputMaybe; /** A delivery address preference of a buyer that is interacting with the cart. */ deliveryAddress?: InputMaybe; }; /** List of different delivery method types. */ export declare 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 declare enum DigitalWallet { /** 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. * */ export declare type DiscountAllocation = { __typename?: 'DiscountAllocation'; /** Amount of discount allocated. */ allocatedAmount: MoneyV2; /** The discount this allocated amount originated from. */ discountApplication: DiscountApplication; }; /** * Discount applications capture the intentions of a discount source at * the time of application. * */ export declare type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** The method by which the discount's value is allocated onto its entitled lines. */ export declare enum DiscountApplicationAllocationMethod { /** The value is spread across all entitled lines. */ Across = "ACROSS", /** The value is applied onto every entitled line. */ Each = "EACH", /** The value is specifically applied onto a particular line. */ One = "ONE" } /** * An auto-generated type for paginating through multiple DiscountApplications. * */ export declare 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. * */ export declare type DiscountApplicationEdge = { __typename?: 'DiscountApplicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountApplicationEdge. */ node: DiscountApplication; }; /** * 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 declare enum DiscountApplicationTargetSelection { /** The discount is allocated onto all the lines. */ All = "ALL", /** 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. * */ export declare enum DiscountApplicationTargetType { /** The discount applies onto line items. */ LineItem = "LINE_ITEM", /** The discount applies onto shipping lines. */ ShippingLine = "SHIPPING_LINE" } /** * Discount code applications capture the intentions of a discount code at * the time that it is applied. * */ export declare type DiscountCodeApplication = DiscountApplication & { __typename?: 'DiscountCodeApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Specifies whether the discount code was applied successfully. */ applicable: Scalars['Boolean']; /** The string identifying the discount code that was used at the time of application. */ code: Scalars['String']; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** Represents an error in the input of a mutation. */ export declare type DisplayableError = { /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Represents a web address. */ export declare type Domain = { __typename?: 'Domain'; /** The host name of the domain (eg: `example.com`). */ host: Scalars['String']; /** Whether SSL is enabled or not. */ sslEnabled: Scalars['Boolean']; /** The URL of the domain (eg: `https://example.com`). */ url: Scalars['URL']; }; /** Represents a video hosted outside of Shopify. */ export declare type ExternalVideo = Media & Node & { __typename?: 'ExternalVideo'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** The embed URL of the video for the respective host. */ embedUrl: Scalars['URL']; /** * The URL. * @deprecated Use `originUrl` instead. */ embeddedUrl: Scalars['URL']; /** The host of the external video. */ host: MediaHost; /** A globally-unique ID. */ id: Scalars['ID']; /** The media content type. */ mediaContentType: MediaContentType; /** The origin URL of the video on the respective host. */ originUrl: Scalars['URL']; /** The presentation for a media. */ presentation?: Maybe; /** The preview image for the media. */ previewImage?: Maybe; }; /** A filter that is supported on the parent field. */ export declare 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/custom-storefronts/products-collections/filter-products). * */ export declare 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 declare 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 declare type Fulfillment = { __typename?: 'Fulfillment'; /** List of the fulfillment's line items. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** The name of the tracking company. */ trackingCompany?: Maybe; /** * Tracking information associated with the fulfillment, * such as the tracking number and tracking URL. * */ trackingInfo: Array; }; /** Represents a single fulfillment in an order. */ export declare type FulfillmentFulfillmentLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents a single fulfillment in an order. */ export declare type FulfillmentTrackingInfoArgs = { first?: InputMaybe; }; /** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ export declare type FulfillmentLineItem = { __typename?: 'FulfillmentLineItem'; /** The associated order's line item. */ lineItem: OrderLineItem; /** The amount fulfilled in this fulfillment. */ quantity: Scalars['Int']; }; /** * An auto-generated type for paginating through multiple FulfillmentLineItems. * */ export declare 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. * */ export declare type FulfillmentLineItemEdge = { __typename?: 'FulfillmentLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; /** Tracking information associated with the fulfillment. */ export declare type FulfillmentTrackingInfo = { __typename?: 'FulfillmentTrackingInfo'; /** The tracking number of the fulfillment. */ number?: Maybe; /** The URL to track the fulfillment. */ 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 declare type GenericFile = Node & { __typename?: 'GenericFile'; /** A word or phrase to indicate the contents of a file. */ alt?: Maybe; /** A globally-unique ID. */ 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; }; /** The input fields used to specify a geographical location. */ export declare 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 declare type HasMetafields = { /** 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>; }; /** Represents information about the metafields associated to the specified resource. */ export declare type HasMetafieldsMetafieldArgs = { key: Scalars['String']; namespace: Scalars['String']; }; /** Represents information about the metafields associated to the specified resource. */ export declare type HasMetafieldsMetafieldsArgs = { identifiers: Array; }; /** The input fields to identify a metafield on an owner resource by namespace and key. */ export declare type HasMetafieldsIdentifier = { /** The identifier for the metafield. */ key: Scalars['String']; /** A container for a set of metafields. */ namespace: Scalars['String']; }; /** Represents an image resource. */ export declare type Image = { __typename?: 'Image'; /** A word or phrase to share the nature or contents of an image. */ altText?: Maybe; /** The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify. */ height?: Maybe; /** A unique ID for the image. */ id?: Maybe; /** * 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 Use `url` instead. */ src: Scalars['URL']; /** * 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. * * @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 declare type ImageTransformedSrcArgs = { crop?: InputMaybe; maxHeight?: InputMaybe; maxWidth?: InputMaybe; preferredContentType?: InputMaybe; scale?: InputMaybe; }; /** Represents an image resource. */ export declare type ImageUrlArgs = { transform?: InputMaybe; }; /** * An auto-generated type for paginating through multiple Images. * */ export declare 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 declare enum ImageContentType { /** 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. * */ export declare type ImageEdge = { __typename?: 'ImageEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of 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 declare 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 declare 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 declare 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 declare 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; /** The market including the country of the active localized experience. Use the `@inContext` directive to change this value. */ market: Market; }; /** Represents a location where product inventory is held. */ export declare type Location = HasMetafields & Node & { __typename?: 'Location'; /** The address of the location. */ address: LocationAddress; /** A globally-unique ID. */ 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 name of the location. */ name: Scalars['String']; }; /** Represents a location where product inventory is held. */ export declare type LocationMetafieldArgs = { key: Scalars['String']; namespace: Scalars['String']; }; /** Represents a location where product inventory is held. */ export declare type LocationMetafieldsArgs = { identifiers: Array; }; /** * Represents the address of a location. * */ export declare 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